diff --git a/.travis.yml b/.travis.yml index 9bc5dc2c7f75..f2d34e652a8d 100644 --- a/.travis.yml +++ b/.travis.yml @@ -8,15 +8,8 @@ services: env: matrix: - MODE=branchStrategy - - MODE=semantic PR_ONLY=true CHECK_NAME="Semantic Validator" - - MODE=model PR_ONLY=true CHECK_NAME="Model Validator" - - MODE=BreakingChange PR_ONLY=true CHECK_NAME="Breaking Changes" - - MODE=lintdiff PR_ONLY=true CHECK_NAME="Linter Diff" NODE_OPTIONS=--max-old-space-size=8192 matrix: fast_finish: true - allow_failures: - - env: MODE=model PR_ONLY=true CHECK_NAME="Model Validator" - - env: MODE=BreakingChange PR_ONLY=true CHECK_NAME="Breaking Changes" install: true script: - >- @@ -24,29 +17,3 @@ script: # Check to ensure CI is not executing for a PR against the master branch in the private repository ! [[ $TRAVIS_PULL_REQUEST != 'false' && $TRAVIS_REPO_SLUG == 'Azure/azure-rest-api-specs-pr' && $TRAVIS_BRANCH == 'master' ]] fi - - >- - if [[ $MODE == 'semantic' ]]; then - npm install - npm run tsc - node scripts/semanticValidation.js - fi - - >- - if [[ $MODE == 'model' ]]; then - npm install - npm run tsc - node scripts/modelValidation.js - fi - - >- - if [[ $MODE == 'BreakingChange' ]]; then - scripts/install-dotnet.sh - npm install - npm run tsc - node scripts/breaking-change.js - fi - - >- - if [[ $MODE == 'lintdiff' ]]; then - scripts/install-dotnet.sh - npm install - npm run tsc - node scripts/momentOfTruth.js && node scripts/momentOfTruthPostProcessing.js - fi diff --git a/.vscode/settings.json b/.vscode/settings.json index 3c87fbc2497c..86500570ba6b 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -19,5 +19,6 @@ ], "url":"https://raw.githubusercontent.com/Azure/autorest/master/schema/composite-swagger.json" } - ] + ], + "typescript.tsdk": "node_modules\\typescript\\lib" } \ No newline at end of file diff --git a/CODEOWNERS b/CODEOWNERS index 92d3f23dd5f1..33a119211adb 100644 --- a/CODEOWNERS +++ b/CODEOWNERS @@ -73,3 +73,4 @@ /specification/timeseriesinsights/ @sandshadow /specification/trafficmanager/ @allencal @hrkulkarmsft /specification/web/ @lukaszstem @naveedaz @nking92 +/profile/ @shahabhijeet diff --git a/azure-pipelines.yml b/azure-pipelines.yml index 311579a274fd..3f863a2365ae 100644 --- a/azure-pipelines.yml +++ b/azure-pipelines.yml @@ -58,7 +58,6 @@ jobs: - job: "Avocado" pool: vmImage: 'Ubuntu 16.04' - continueOnError: true steps: - task: Npm@1 displayName: 'npm install' @@ -68,12 +67,11 @@ jobs: displayName: 'Avocado' - job: "BreakingChange" - condition: "not(variables['PRIVATE'])" pool: vmImage: 'Ubuntu 16.04' steps: - script: 'scripts/install-dotnet.sh' - displayName: 'Insall .Net' + displayName: 'Install .Net' - task: Npm@1 displayName: 'npm install' inputs: @@ -82,7 +80,6 @@ jobs: displayName: 'Breaking Changes' - job: "LintDiff" - condition: "not(variables['PRIVATE'])" variables: NODE_OPTIONS: '--max-old-space-size=8192' pool: diff --git a/package.json b/package.json index c9e130ae6788..cf540ccbac6c 100644 --- a/package.json +++ b/package.json @@ -10,17 +10,18 @@ "description": "Tests for Azure REST API Specifications", "license": "MIT", "devDependencies": { - "@azure/avocado": "^0.3.3", - "@azure/oad": "^0.5.1", - "@azure/rest-api-specs-scripts": "^0.1.8", + "@azure/avocado": "^0.4.1", + "@azure/oad": "^0.6.3", + "@azure/rest-api-specs-scripts": "^0.3.9", "@microsoft.azure/async-io": "^2.0.21", "@microsoft.azure/literate": "^1.0.25", "@microsoft.azure/polyfill": "^1.0.19", - "@octokit/rest": "^16.24.1", + "@octokit/rest": "^16.25.0", "@ts-common/commonmark-to-markdown": "^1.2.0", "@ts-common/fs": "0.2.0", "@types/fs-extra": "^5.0.5", "@types/js-yaml": "^3.12.1", + "@types/mocha": "^5.2.6", "@types/request": "^2.48.1", "fs-extra": "^7.0.1", "glob": "^7.1.3", @@ -31,7 +32,7 @@ "request": "^2.88.0", "request-promise-native": "^1.0.7", "ts-node": "^8.1.0", - "typescript": "^3.4.3", + "typescript": "^3.4.4", "z-schema": "^4.0.2" }, "homepage": "https://github.com/azure/azure-rest-api-specs", diff --git a/preproduction-azure-pipelines.yml b/preproduction-azure-pipelines.yml index 122c66f7376d..0f888ebbd851 100644 --- a/preproduction-azure-pipelines.yml +++ b/preproduction-azure-pipelines.yml @@ -1,4 +1,4 @@ -name: "Preproduction CI for Azure Rest API speciications" +name: "Preproduction CI for Azure Rest API specifications" trigger: none @@ -13,6 +13,14 @@ variables: jobs: +- job: "BranchProtection" + pool: + vmImage: 'Ubuntu 16.04' + condition: and(variables['PRIVATE'], eq(variables['System.PullRequest.TargetBranch'], 'master')) + steps: + - script: '>&2 echo "the branch is protected"' + failOnStderr: true + - job: "Syntax" pool: vmImage: 'Ubuntu 16.04' @@ -30,7 +38,7 @@ jobs: displayName: 'npm install' inputs: verbose: false - - script: 'npm install -D @azure/rest-api-specs-scripts@0.2.21 @azure/oad@0.6.3' + - script: 'npm install -D @azure/rest-api-specs-scripts@0.3.9' - script: 'npm test -- test/syntax.js' displayName: 'Syntax validation' @@ -42,7 +50,7 @@ jobs: displayName: 'npm install' inputs: verbose: false - - script: 'npm install -D @azure/rest-api-specs-scripts@0.2.21 @azure/oad@0.6.3' + - script: 'npm install -D @azure/rest-api-specs-scripts@0.3.9' - script: 'npm run tsc && node scripts/semanticValidation.js' displayName: 'Semantic Validation' @@ -54,7 +62,7 @@ jobs: displayName: 'npm install' inputs: verbose: false - - script: 'npm install -D @azure/rest-api-specs-scripts@0.2.21 @azure/oad@0.6.3' + - script: 'npm install -D @azure/rest-api-specs-scripts@0.3.9' - script: 'npm run tsc && node scripts/modelValidation.js' displayName: 'Model Validation' @@ -80,7 +88,7 @@ jobs: displayName: 'npm install' inputs: verbose: false - - script: 'npm install -D @azure/rest-api-specs-scripts@0.2.21 @azure/oad@0.6.3' + - script: 'npm install -D @azure/rest-api-specs-scripts@0.3.9' - script: 'npm run tsc && node scripts/breaking-change.js' displayName: 'Breaking Changes' @@ -96,37 +104,6 @@ jobs: verbose: false - script: 'scripts/install-dotnet.sh' displayName: 'install .Net' - - script: 'npm install -D @azure/rest-api-specs-scripts@0.2.21 @azure/oad@0.6.3' + - script: 'npm install -D @azure/rest-api-specs-scripts@0.3.9' - script: 'npm run tsc && node scripts/momentOfTruth.js && node scripts/momentOfTruthPostProcessing.js' displayName: 'LintDiff' - -- job: "SDK" - timeoutInMinutes: 120 - strategy: - matrix: - ruby: - AZURE_SDK_REPO: azure-sdk-for-ruby - AZURE_SDK_PARAMS: '' - java: - AZURE_SDK_REPO: azure-sdk-for-java - AZURE_SDK_PARAMS: '' - javascript: - AZURE_SDK_REPO: azure-sdk-for-js - AZURE_SDK_PARAMS: '' - node: - AZURE_SDK_REPO: azure-sdk-for-node - AZURE_SDK_PARAMS: '' - python: - AZURE_SDK_REPO: azure-sdk-for-python - AZURE_SDK_PARAMS: '' - go: - AZURE_SDK_REPO: azure-sdk-for-go - AZURE_SDK_PARAMS: '-o latest' - pool: - vmImage: 'Ubuntu 16.04' - variables: - NODE_OPTIONS: '--max-old-space-size=8192' - steps: - - script: echo $(NODE_OPTIONS) - - script: "scripts/swagger-to-sdk.sh Azure/$(AZURE_SDK_REPO) -v $(AZURE_SDK_PARAMS)" - displayName: "Swagger to SDK script" diff --git a/profile/2019-03-01-hybrid.json b/profile/2019-03-01-hybrid.json index a76b67ce3e83..5775e60d4fbb 100644 --- a/profile/2019-03-01-hybrid.json +++ b/profile/2019-03-01-hybrid.json @@ -6,175 +6,472 @@ "resource-manager": { "microsoft.authorization": { "2016-09-01": [ - "locks" + { + "resourceType": "locks", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/resources/resource-manager/Microsoft.Authorization/stable/2016-09-01/locks.json" + } ], "2016-12-01": [ - "policyDefinitions", - "policyAssignments" + { + "resourceType": "policyDefinitions", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/resources/resource-manager/Microsoft.Authorization/stable/2016-12-01/policyDefinitions.json" + }, + { + "resourceType": "policyAssignments", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/resources/resource-manager/Microsoft.Authorization/stable/2016-12-01/policyAssignments.json" + } ], "2015-07-01": [ - "operations", - "permissions", - "roleAssignments", - "roleDefinitions", - "providerOperations" + { + "resourceType": "permissions", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/authorization/resource-manager/Microsoft.Authorization/stable/2015-07-01/authorization.json" + }, + { + "resourceType": "roleAssignments", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/authorization/resource-manager/Microsoft.Authorization/stable/2015-07-01/authorization.json" + }, + + { + "resourceType": "roleDefinitions", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/authorization/resource-manager/Microsoft.Authorization/stable/2015-07-01/authorization.json" + }, + { + "resourceType": "providerOperations", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/authorization/resource-manager/Microsoft.Authorization/stable/2015-07-01/authorization.json" + } ] }, "microsoft.compute": { "2017-12-01": [ - "availabilitySets", - "images", - "locations", - "locations/publishers", - "locations/operations", - "locations/usages", - "locations/vmSizes", - "operations", - "virtualMachines", - "virtualMachines/extensions", - "virtualMachineScaleSets", - "virtualMachineScaleSets/extensions", - "virtualmachineScaleSets/networkInterfaces", - "virtualMachineScaleSets/virtualMachines", - "virtualMachineScaleSets/virtualMachines/networkInterfaces" + { + "resourceType": "availabilitySets", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/compute.json" + }, + { + "resourceType": "images", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/compute.json" + }, + { + "resourceType": "locations", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/compute.json" + }, + { + "resourceType": "locations/publishers", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/compute.json" + }, + { + "resourceType": "locations/operations", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/compute.json" + }, + { + "resourceType": "locations/usages", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/compute.json" + }, + { + "resourceType": "locations/vmSizes", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/compute.json" + }, + { + "resourceType": "operations", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/compute.json" + }, + { + "resourceType": "virtualMachines", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/compute.json" + }, + { + "resourceType": "virtualMachines/extensions", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/compute.json" + }, + { + "resourceType": "virtualMachineScaleSets", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/compute.json" + }, + { + "resourceType": "virtualMachineScaleSets/extensions", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/compute.json" + }, + { + "resourceType": "virtualmachineScaleSets/networkInterfaces", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/compute.json" + }, + { + "resourceType": "virtualMachineScaleSets/virtualMachines", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/compute.json" + }, + { + "resourceType": "virtualMachineScaleSets/virtualMachines/networkInterfaces", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/compute.json" + } ], "2017-03-30": [ - "disks", - "locations/diskoperations", - "snapshots" + { + "resourceType": "disks", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/compute/resource-manager/Microsoft.Compute/stable/2017-03-30/disk.json" + }, + { + "resourceType": "snapshots", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/compute/resource-manager/Microsoft.Compute/stable/2017-03-30/disk.json" + } ] }, "microsoft.insights": { "2018-01-01": [ - "metricDefinitions", - "metrics" + { + "resourceType": "metricDefinitions", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/monitor/resource-manager/Microsoft.Insights/stable/2018-01-01/metricDefinitions_API.json" + }, + { + "resourceType": "metrics", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/monitor/resource-manager/Microsoft.Insights/stable/2018-01-01/metrics_API.json" + } ], "2017-05-01-preview": [ - "diagnosticSettings", - "diagnosticSettingCategories" + { + "resourceType": "diagnosticSettings", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/monitor/resource-manager/Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettings_API.json" + }, + { + "resourceType": "diagnosticSettingCategories", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/monitor/resource-manager/Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettingsCategories_API.json" + } ], "2015-04-01": [ - "eventTypes", - "eventCategories", - "operations" + { + "resourceType": "eventCategories", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/monitor/resource-manager/Microsoft.Insights/stable/2015-04-01/eventCategories_API.json" + }, + { + "resourceType": "operations", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/monitor/resource-manager/Microsoft.Insights/stable/2015-04-01/operations_API.json" + } ] }, "microsoft.keyvault": { "2016-10-01": [ - "operations", - "vaults", - "vaults/accessPolicies", - "vaults/secrets" + { + "resourceType": "operations", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2016-10-01/providers.json" + }, + { + "resourceType": "vaults", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2016-10-01/keyvault.json" + }, + { + "resourceType": "vaults/accessPolicies", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2016-10-01/keyvault.json" + }, + { + "resourceType": "vaults/secrets", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2016-10-01/secrets.json" + } ] }, "microsoft.network": { "2017-10-01": [ - "connections", - "loadBalancers", - "localNetworkGateways", - "locations", - "locations/operationResults", - "locations/operations", - "locations/usages", - "networkInterfaces", - "networkSecurityGroups", - "operations", - "publicIpAddresses", - "routeTables", - "virtualNetworkGateways", - "virtualNetworks" + { + "resourceType": "connections", + "path": "" + }, + { + "resourceType": "loadBalancers", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/network/resource-manager/Microsoft.Network/stable/2017-10-01/loadBalancer.json" + }, + { + "resourceType": "localNetworkGateways", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/network/resource-manager/Microsoft.Network/stable/2017-10-01/virtualNetworkGateway.json" + }, + { + "resourceType": "locations", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/network/resource-manager/Microsoft.Network/stable/2017-10-01/network.json" + }, + { + "resourceType": "locations/operationResults", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/network/resource-manager/Microsoft.Network/stable/2017-10-01/network.json" + }, + { + "resourceType": "locations/operations", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/network/resource-manager/Microsoft.Network/stable/2017-10-01/network.json" + }, + { + "resourceType": "locations/usages", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/network/resource-manager/Microsoft.Network/stable/2017-10-01/network.json" + }, + { + "resourceType": "networkInterfaces", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/network/resource-manager/Microsoft.Network/stable/2017-10-01/networkInterface.json" + }, + { + "resourceType": "networkSecurityGroups", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/network/resource-manager/Microsoft.Network/stable/2017-10-01/networkSecurityGroup.json" + }, + { + "resourceType": "operations", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/network/resource-manager/Microsoft.Network/stable/2017-10-01/operation.json" + }, + { + "resourceType": "publicIpAddresses", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/network/resource-manager/Microsoft.Network/stable/2017-10-01/publicIpAddress.json" + }, + { + "resourceType": "routeTables", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/network/resource-manager/Microsoft.Network/stable/2017-10-01/routeTable.json" + }, + { + "resourceType": "virtualNetworkGateways", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/network/resource-manager/Microsoft.Network/stable/2017-10-01/virtualNetworkGateway.json" + }, + { + "resourceType": "virtualNetworks", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/network/resource-manager/Microsoft.Network/stable/2017-10-01/virtualNetwork.json" + } ], "2016-04-01": [ - "dnsZones" + { + "resourceType": "dnsZones", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/dns/resource-manager/Microsoft.Network/stable/2016-04-01/dns.json" + } ] }, "microsoft.resources": { "2016-06-01": [ - "subscriptions", - "subscriptions/locations", - "tenants" + { + "resourceType": "subscriptions", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/resources/resource-manager/Microsoft.Resources/stable/2016-06-01/subscriptions.json" + }, + { + "resourceType": "subscriptions/locations", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/resources/resource-manager/Microsoft.Resources/stable/2016-06-01/subscriptions.json" + }, + { + "resourceType": "tenants", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/resources/resource-manager/Microsoft.Resources/stable/2016-06-01/subscriptions.json" + } ], "2018-05-01": [ - "deployments", - "deployments/operations", - "links", - "locations", - "operations", - "providers", - "resourceGroups", - "resources", - "subscriptions/operationresults", - "subscriptions/providers", - "subscriptions/resourceGroups", - "subscriptions/resourceGroups/resources", - "subscriptions/resources", - "subscriptions/tagNames", - "subscriptions/tagNames/tagValues" + { + "resourceType": "deployments", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/resources/resource-manager/Microsoft.Resources/stable/2018-05-01/resources.json" + }, + { + "resourceType": "deployments/operations", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/resources/resource-manager/Microsoft.Resources/stable/2018-05-01/resources.json" + }, + { + "resourceType": "links", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/resources/resource-manager/Microsoft.Resources/stable/2018-05-01/resources.json" + }, + { + "resourceType": "locations", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/resources/resource-manager/Microsoft.Resources/stable/2018-05-01/resources.json" + }, + { + "resourceType": "operations", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/resources/resource-manager/Microsoft.Resources/stable/2018-05-01/resources.json" + }, + { + "resourceType": "providers", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/resources/resource-manager/Microsoft.Resources/stable/2018-05-01/resources.json" + }, + { + "resourceType": "resourceGroups", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/resources/resource-manager/Microsoft.Resources/stable/2018-05-01/resources.json" + }, + { + "resourceType": "resources", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/resources/resource-manager/Microsoft.Resources/stable/2018-05-01/resources.json" + }, + { + "resourceType": "subscriptions/operationresults", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/resources/resource-manager/Microsoft.Resources/stable/2018-05-01/resources.json" + }, + { + "resourceType": "subscriptions/providers", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/resources/resource-manager/Microsoft.Resources/stable/2018-05-01/resources.json" + }, + { + "resourceType": "subscriptions/resourceGroups", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/resources/resource-manager/Microsoft.Resources/stable/2018-05-01/resources.json" + }, + { + "resourceType": "subscriptions/resourceGroups/resources", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/resources/resource-manager/Microsoft.Resources/stable/2018-05-01/resources.json" + }, + { + "resourceType": "subscriptions/resources", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/resources/resource-manager/Microsoft.Resources/stable/2018-05-01/resources.json" + }, + { + "resourceType": "subscriptions/tagNames", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/resources/resource-manager/Microsoft.Resources/stable/2018-05-01/resources.json" + }, + { + "resourceType": "subscriptions/tagNames/tagValues", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/resources/resource-manager/Microsoft.Resources/stable/2018-05-01/resources.json" + } ] }, "microsoft.storage": { "2017-10-01": [ - "checkNameAvailability", - "locations", - "locations/quotas", - "operations", - "storageAccounts", - "storageAccounts/blobServices", - "storageAccounts/queueServices", - "storageAccounts/tableServices", - "usages" + { + "resourceType": "checkNameAvailability", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/storage/resource-manager/Microsoft.Storage/stable/2017-10-01/storage.json" + }, + { + "resourceType": "locations", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/storage/resource-manager/Microsoft.Storage/stable/2017-10-01/storage.json" + }, + { + "resourceType": "locations/quotas", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/storage/resource-manager/Microsoft.Storage/stable/2017-10-01/storage.json" + }, + { + "resourceType": "operations", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/storage/resource-manager/Microsoft.Storage/stable/2017-10-01/storage.json" + }, + { + "resourceType": "storageAccounts", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/storage/resource-manager/Microsoft.Storage/stable/2017-10-01/storage.json" + }, + { + "resourceType": "storageAccounts/blobServices", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/storage/resource-manager/Microsoft.Storage/stable/2017-10-01/storage.json" + }, + { + "resourceType": "storageAccounts/queueServices", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/storage/resource-manager/Microsoft.Storage/stable/2017-10-01/storage.json" + }, + { + "resourceType": "storageAccounts/tableServices", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/storage/resource-manager/Microsoft.Storage/stable/2017-10-01/storage.json" + }, + { + "resourceType": "usages", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/storage/resource-manager/Microsoft.Storage/stable/2017-10-01/storage.json" + } ] }, "microsoft.web": { "2018-02-01": [ - "certificates", - "operations", - "checknameavailability", - "sites", - "sites/domainOwnershipIdentifiers", - "sites/extensions", - "sites/hostNameBindings", - "sites/instances", - "sites/instances/extensions", - "sites/slots", - "sites/slots/hostNameBindings", - "sites/slots/instances", - "sites/slots/instances/extensions", - "serverFarms" + { + "resourceType": "certificates", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/Certificates.json" + }, + { + "resourceType": "operations", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/WebApps.json" + }, + { + "resourceType": "checknameavailability", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/ResourceProvider.json" + }, + { + "resourceType": "metadata", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/WebApps.json" + }, + { + "resourceType": "sites", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/WebApps.json" + }, + { + "resourceType": "sites/domainOwnershipIdentifiers", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/WebApps.json" + }, + { + "resourceType": "sites/extensions", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/WebApps.json" + }, + { + "resourceType": "sites/hostNameBindings", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/WebApps.json" + }, + { + "resourceType": "sites/instances", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/WebApps.json" + }, + { + "resourceType": "sites/instances/extensions", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/WebApps.json" + }, + { + "resourceType": "sites/slots", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/WebApps.json" + }, + { + "resourceType": "sites/slots/hostNameBindings", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/WebApps.json" + }, + { + "resourceType": "sites/slots/instances", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/WebApps.json" + }, + { + "resourceType": "sites/slots/instances/extensions", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/WebApps.json" + }, + { + "resourceType": "serverFarms", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/WebApps.json" + } ], "2016-09-01": [ - "serverFarms/metricDefinitions", - "serverFarms/metrics", - "serverFarms/usages" - ], - "2016-08-01": [ - "metadata", - "sites/extensions", - "sites/metricDefinitions", - "sites/metrics", - "sites/recommendations", - "sites/slots/extensions", - "sites/slots/metricDefinitions", - "sites/slots/metrics" + { + "resourceType": "serverFarms/metricDefinitions", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/web/resource-manager/Microsoft.Web/stable/2016-09-01/AppServicePlans.json" + }, + { + "resourceType": "serverFarms/metrics", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/web/resource-manager/Microsoft.Web/stable/2016-09-01/AppServicePlans.json" + }, + { + "resourceType": "serverFarms/usages", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/web/resource-manager/Microsoft.Web/stable/2016-09-01/AppServicePlans.json" + } ], "2016-03-01": [ - "availableStacks", - "deploymentLocations", - "georegions", - "ishostnameavailable", - "isusernameavailable", - "listSitesAssignedToHostName", - "publishingUsers", - "recommendations", - "runtimes", - "sourceControls", - "validate" + { + "resourceType": "availableStacks", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/web/resource-manager/Microsoft.Web/stable/2016-03-01/Provider.json" + }, + { + "resourceType": "deploymentLocations", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/web/resource-manager/Microsoft.Web/stable/2016-03-01/ResourceProvider.json" + }, + { + "resourceType": "georegions", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/web/resource-manager/Microsoft.Web/stable/2016-03-01/ResourceProvider.json" + }, + { + "resourceType": "listSitesAssignedToHostName", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/web/resource-manager/Microsoft.Web/stable/2016-03-01/ResourceProvider.json" + }, + { + "resourceType": "publishingUsers", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/web/resource-manager/Microsoft.Web/stable/2016-03-01/ResourceProvider.json" + }, + { + "resourceType": "recommendations", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/web/resource-manager/Microsoft.Web/stable/2016-03-01/Recommendations.json" + }, + { + "resourceType": "sourceControls", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/web/resource-manager/Microsoft.Web/stable/2016-03-01/ResourceProvider.json" + }, + { + "resourceType": "validate", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/web/resource-manager/Microsoft.Web/stable/2016-03-01/ResourceProvider.json" + } ] } }, "data-plane": { "microsoft.keyvault": { - "2016-10-01": [] + "2016-10-01": [ + { + "resourceType": "*", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/keyvault/data-plane/Microsoft.KeyVault/stable/2016-10-01/keyvault.json" + } + ] }, "microsoft.storage": { "2017-11-09": [] diff --git a/scripts/modelValidation.js b/scripts/modelValidation.js deleted file mode 100644 index 9125836799a9..000000000000 --- a/scripts/modelValidation.js +++ /dev/null @@ -1,40 +0,0 @@ -// Copyright (c) Microsoft Corporation. All rights reserved. -// Licensed under the MIT License. See License in the project root for license information. -'use strict'; - -const utils = require('../test/util/utils') -const cp = require("child_process") - -const exec = (cmd, options) => { - const result = cp.spawnSync( - cmd, - { - ...options, - shell: true, - stdio: [process.stdin, process.stdout, process.stderr] - } - ) - return result.status -} - -async function main() { - const swaggersToProcess = utils.getFilesChangedInPR(); - let result = 0 - for (const swagger of swaggersToProcess) { - try { - // await oav.validateExamples(swagger, null, {consoleLogLevel: 'error', pretty: true}); - // run OAV as a separate process to avoid memory issues. - const r = exec(`node node_modules/oav/dist/cli.js validate-example ${swagger} --pretty`) - if (result === 0) { - result = r - } - } catch (e) { - console.error("error: ") - console.error(e) - result = 1 - } - } - process.exitCode = result -} - -main().catch(e => { console.log(e); process.exit(1); }) diff --git a/scripts/ts-utils.ts b/scripts/modelValidation.ts similarity index 52% rename from scripts/ts-utils.ts rename to scripts/modelValidation.ts index 9b9dbb94a898..5fbebe6cfb99 100644 --- a/scripts/ts-utils.ts +++ b/scripts/modelValidation.ts @@ -1,4 +1,6 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT License. See License in the project root for license information. -export const asNonUndefined = (v: T|undefined) => v as T \ No newline at end of file +import { modelValidation } from '@azure/rest-api-specs-scripts' + +modelValidation.main().catch(e => { console.log(e); process.exit(1); }) diff --git a/scripts/momentOfTruthPostProcessing.js b/scripts/momentOfTruthPostProcessing.js deleted file mode 100644 index 0ebada4bc33f..000000000000 --- a/scripts/momentOfTruthPostProcessing.js +++ /dev/null @@ -1,423 +0,0 @@ -// Copyright (c) Microsoft Corporation. All rights reserved. -// Licensed under the MIT License. See License.txt in the project root for license information. - -'use strict'; - -const fs = require('fs'), - utils = require('../test/util/utils'), - path = require('path'), - gitHubPost = require('./postToGitHub'); - -let pullRequestNumber = utils.getPullRequestNumber(); -let targetBranch = utils.getTargetBranch(); -let filename = `${pullRequestNumber}.json`; -let logFilepath = path.join(getLogDir(), filename); - -function getLogDir() { - let logDir = path.join(__dirname, '../', 'output'); - return logDir; -} - -let githubTemplate = (title, contact_message, file_summaries) => `# AutoRest linter results for ${title}\n${contact_message}\n\n${file_summaries}`; - -let tooManyResults = "# Result limit exceeded, check build output\n" + - "The linter diff produced too many results to display here. Please view the build output to see the results. " + - "For help with SDK-related validation Errors / Warnings, reach out to [ADX Swagger Reviewers](mailto:adxsr@microsoft.com). " + - "For help with ARM-related validation Errors / Warnings, reach out to [ARM RP API Review](mailto:armrpapireview@microsoft.com).\n\n" + - `### [View Build Output](https://travis-ci.org/${process.env.TRAVIS_REPO_SLUG}/jobs/${process.env.TRAVIS_JOB_ID})`; - -let githubFooter = `[AutoRest Linter Guidelines](https://github.com/Azure/azure-rest-api-specs/blob/master/documentation/openapi-authoring-automated-guidelines.md) | ` + - `[AutoRest Linter Issues](https://github.com/Azure/azure-openapi-validator/issues) | ` + - `Send ${emailLink("feedback", "azure-swag-tooling@microsoft.com", "Feedback | AutoRest Linter Diff Tool")}` + - `\n\nThanks for your co-operation.`; - -let fileSummaryHeader = (file_name, file_href) => `## Config file: [${file_name}](${file_href})\n`; -let fileSummaryNewTemplate = (issue_type, issue_count, issue_table) => `

${iconFor(issue_type)} ${issue_count} new ${pluralize(issue_type, issue_count)}


\n\n${issue_table}\n
`; -let fileSummaryExistingTemplate = (issue_type, issue_count, issue_table) => `
${iconFor(issue_type)} ${issue_count} existing ${pluralize(issue_type, issue_count)}
\n\n${issue_table}\n
\n\n`; - -let potentialNewWarningErrorSummaryHeader = ` -| | Rule | Location | Message | -|-|------|----------|---------| -`; - -let potentialNewWarningErrorSummaryMarkdown = (count, warning_error_id, warning_error_code, warning_error_file, warning_error_line, warning_error_message) => - `|${count}|[${warning_error_id} - ${warning_error_code}](https://github.com/Azure/azure-rest-api-specs/blob/master/documentation/openapi-authoring-automated-guidelines.md#${warning_error_id})|` + - `[${shortName(warning_error_file)}:${warning_error_line}](${blobHref(warning_error_file)}#L${warning_error_line} "${warning_error_file}")|` + - `${warning_error_message}|\n`; - -let potentialNewWarningErrorSummaryPlain = (count, warning_error_id, warning_error_code, warning_error_file, warning_error_line, warning_error_message) => - `${warning_error_id} - ${warning_error_code}\n` + - `${warning_error_message}\n` + - ` at ${warning_error_file}:${warning_error_line}\n\n`; - -let sdkContactMessage = "These errors are reported by the SDK team's validation tools, reach out to [ADX Swagger Reviewers](mailto:adxsr@microsoft.com) directly for any questions or concerns."; -let armContactMessage = "These errors are reported by the ARM team's validation tools, reach out to [ARM RP API Review](mailto:armrpapireview@microsoft.com) directly for any questions or concerns."; -let sdkFileSummaries = '', armFileSummaries = ''; - -let data = undefined; -let jsonData = undefined; -try { - data = fs.readFileSync(logFilepath, 'utf8'); - jsonData = JSON.parse(data); -} catch (e) { - console.log(`Failed to read diff results from file ${logFilepath}`); - console.log("File content:"); - console.log(data); - process.exit(1) -} - -function compareJsonRef(beforeJsonRef, afterJsonRef) { - beforeJsonRef = beforeJsonRef.replace(/.*\.json:\d+:\d+/, '') - afterJsonRef = afterJsonRef.replace(/.*\.json:\d+:\d+/, '') - - return (beforeJsonRef == afterJsonRef); -} - -function getOutputMessages(newSDKErrorsCount, newARMErrorsCount, newSDKWarningsCount, newARMWarningsCount) { - const totalNewErrors = newSDKErrorsCount + newARMErrorsCount; - const totalNewWarnings = newSDKWarningsCount + newARMWarningsCount; - - const title = `${totalNewErrors} new ${pluralize('error', totalNewErrors)} / ${totalNewWarnings} new ${pluralize('warning', totalNewWarnings)}`; - let summary = `Compared to the target branch (**${targetBranch}**), this pull request introduces:\n\n`; - summary += formatSummaryLine("SDK Error", newSDKErrorsCount); - summary += formatSummaryLine("ARM Error", newARMErrorsCount); - summary += formatSummaryLine("SDK Warning", newSDKWarningsCount); - summary += formatSummaryLine("ARM Warning", newARMWarningsCount); - - return [title, summary]; -} - -function formatSummaryLine(issueType, count) { - let line = `   ${iconFor(issueType, count)}   `; - if (count > 0) { - line += '['; - } - line += `**${count}** new ${pluralize(issueType, count)}`; - if (count > 0) { - line += `](#user-content-${issueType.replace(/\s/g, "-")}s)`; - } - line += "\n\n"; - return line; -} - -function getSummaryBlock(summaryTitle, fileSummaries, contactMessage) { - return githubTemplate( - summaryTitle, - contactMessage, - fileSummaries !== "" ? fileSummaries : `**There were no files containing ${summaryTitle}.**` - ); -} - -function compareBeforeAfterArrays(afterArray, beforeArray, existingArray, newArray) { - if(afterArray.length > beforeArray.length){ - afterArray.forEach(afterValue => { - let errorFound = false; - beforeArray.forEach(beforeValue => { - if( - beforeValue.type == afterValue.type && - beforeValue.code == afterValue.code && - beforeValue.message == afterValue.message && - beforeValue.id == afterValue.id && - beforeValue.validationCategory == afterValue.validationCategory && - beforeValue.providerNamespace == afterValue.providerNamespace && - beforeValue.resourceType == afterValue.resourceType && - beforeValue.sources.length == afterValue.sources.length && - compareJsonRef(beforeValue.jsonref, afterValue.jsonref) - ) { - errorFound = true; - } - }); - if(errorFound) { - existingArray.push(afterValue); - } else { - newArray.push(afterValue); - } - }); - } -} - -function iconFor(type, num = undefined) { - if (num === 0) { - return ':white_check_mark:'; - } - - if (type.toLowerCase().includes('error')) { - return ':x:'; - } else { - return ':warning:'; - } -} - -function pluralize(word, num) { - return num !== 1 ? `${word}s` : word; -} - -function getLine(jsonRef) { - try { - return jsonRef.substr(jsonRef.indexOf(".json:") + 6).split(':')[0]; - } catch (error) { - return undefined; - } -} - -function getFile(jsonRef) { - try { - const start = jsonRef.indexOf("specification"); - return jsonRef.substr(start, (jsonRef.indexOf(".json") + 5) - start); - } catch (error) { - return undefined; - } -} - -function shortName(filePath) { - return `${path.basename(path.dirname(filePath))}/​${path.basename(filePath)}`; -} - -function blobHref(file) { - return `https://github.com/${process.env.TRAVIS_PULL_REQUEST_SLUG}/blob/${process.env.TRAVIS_PULL_REQUEST_SHA}/${file}`; -} - -function getFileSummaryTable(issues, header, formatter) { - let potentialNewIssues = header; - - issues.sort((a, b) => { - if (!a.filePath) { - a.filePath = getFile(a.jsonref) || ""; - a.lineNumber = getLine(a.jsonref) || "1"; - } - - if (!b.filePath) { - b.filePath = getFile(b.jsonref) || ""; - b.lineNumber = getLine(b.jsonref) || "1"; - } - - const comparison = a.filePath.localeCompare(b.filePath); - if (comparison !== 0) { - return comparison; - } else if (a.lineNumber !== b.lineNumber) { - return a.lineNumber - b.lineNumber; - } else { - return a.id.localeCompare(b.id); - } - }); - - issues.forEach(function (issue, count) { - if (!issue.filePath) { - issue.filePath = getFile(issue.jsonref) || ""; - issue.lineNumber = getLine(issue.jsonref) || "1"; - } - - potentialNewIssues += formatter( - count + 1, - issue.id, - issue.code, - issue.filePath, - issue.lineNumber, - issue.message - ); - }); - - return potentialNewIssues; -} - -function getFileSummary(issueType, fileName, existingWarnings, existingErrors, newWarnings, newErrors) { - let fileSummary = ""; - - if (newErrors.length > 0) { - fileSummary += fileSummaryNewTemplate(`${issueType} Error`, newErrors.length, getFileSummaryTable(newErrors, potentialNewWarningErrorSummaryHeader, potentialNewWarningErrorSummaryMarkdown)); - } - - if (existingErrors.length > 0) { - fileSummary += fileSummaryExistingTemplate(`${issueType} Error`, existingErrors.length, getFileSummaryTable(existingErrors, potentialNewWarningErrorSummaryHeader, potentialNewWarningErrorSummaryMarkdown)); - } - - if (fileSummary !== "") { - fileSummary += "
\n\n"; - } - - if (newWarnings.length > 0) { - fileSummary += fileSummaryNewTemplate(`${issueType} Warning`, newWarnings.length, getFileSummaryTable(newWarnings, potentialNewWarningErrorSummaryHeader, potentialNewWarningErrorSummaryMarkdown)); - } - - if (existingWarnings.length > 0) { - fileSummary += fileSummaryExistingTemplate(`${issueType} Warning`, existingWarnings.length, getFileSummaryTable(existingWarnings, potentialNewWarningErrorSummaryHeader, potentialNewWarningErrorSummaryMarkdown)); - } - - if (fileSummary !== "") { - return fileSummaryHeader(fileName, blobHref(fileName)) + fileSummary; - } else { - return ""; - } -} - -function emailLink(title, addr, subject = "", body = "") { - let link = `${title}`; - - return link; -} - -function postProcessing() { - let newSDKErrorsCount = 0, newARMErrorsCount = 0, newSDKWarningsCount = 0, newARMWarningsCount = 0; - - console.log("\n---------- Linter Diff Results ----------\n") - - if (!jsonData) { - const reportLink = emailLink( - "report this failure", - "azure-swag-tooling@microsoft.com", - "Failure | AutoRest Linter Diff Tool", - `Please examine the failure in PR https://github.com/${process.env.TRAVIS_REPO_SLUG}/pull/${pullRequestNumber}\r\nThe failing job is https://travis-ci.org/${process.env.TRAVIS_REPO_SLUG}/jobs/${process.env.TRAVIS_JOB_ID}` - ); - - const output = { - title: "Failed to produce a result", - summary: `The Linter Diff tool failed to produce a result. Work with your reviewer to examine the lint results manually before merging.\n\nPlease ${reportLink}!` - }; - - console.log("---output"); - console.log(JSON.stringify(output)); - console.log("---"); - - return; - } - - const configFiles = Object.keys(jsonData['files']); - configFiles.sort(); - - for (const fileName of configFiles) { - let beforeErrorsSDKArray = [], beforeWarningsSDKArray = [], beforeErrorsARMArray = [], beforeWarningsARMArray = []; - let afterErrorsSDKArray = [], afterWarningsSDKArray = [], afterErrorsARMArray = [], afterWarningsARMArray = []; - let newSDKErrors = [], newSDKWarnings = [], newARMErrors = [], newARMWarnings = []; - let existingSDKErrors = [], existingSDKWarnings = [], existingARMErrors = [], existingARMWarnings = []; - - let beforeErrorsAndWarningsArray = jsonData['files'][fileName]['before']; - beforeErrorsAndWarningsArray.forEach(beforeErrorOrWarning => { - if(beforeErrorOrWarning.type != undefined && beforeErrorOrWarning.type.toLowerCase() == 'warning'){ - if(beforeErrorOrWarning.validationCategory.toLowerCase() == 'sdkviolation') { - beforeWarningsSDKArray.push(beforeErrorOrWarning); - } else { - beforeWarningsARMArray.push(beforeErrorOrWarning); - } - } - - if(beforeErrorOrWarning.type != undefined && beforeErrorOrWarning.type.toLowerCase() == 'error'){ - if(beforeErrorOrWarning.validationCategory.toLowerCase() == 'sdkviolation') { - beforeErrorsSDKArray.push(beforeErrorOrWarning); - } else { - beforeErrorsARMArray.push(beforeErrorOrWarning); - } - } - }); - - let afterErrorsAndWarningsArray = jsonData['files'][fileName]['after']; - afterErrorsAndWarningsArray.forEach(afterErrorOrWarning => { - if(afterErrorOrWarning.type != undefined && afterErrorOrWarning.type.toLowerCase() == 'warning'){ - if(afterErrorOrWarning.validationCategory.toLowerCase() == 'sdkviolation') { - afterWarningsSDKArray.push(afterErrorOrWarning); - } else { - afterWarningsARMArray.push(afterErrorOrWarning); - } - } - - if(afterErrorOrWarning.type != undefined && afterErrorOrWarning.type.toLowerCase() == 'error'){ - if(afterErrorOrWarning.validationCategory.toLowerCase() == 'sdkviolation') { - afterErrorsSDKArray.push(afterErrorOrWarning); - } else { - afterErrorsARMArray.push(afterErrorOrWarning); - } - } - }); - - compareBeforeAfterArrays(afterErrorsARMArray, beforeErrorsARMArray, existingARMErrors, newARMErrors); - compareBeforeAfterArrays(afterErrorsSDKArray, beforeErrorsSDKArray, existingSDKErrors, newSDKErrors); - compareBeforeAfterArrays(afterWarningsARMArray, beforeWarningsARMArray, existingARMWarnings, newARMWarnings); - compareBeforeAfterArrays(afterWarningsSDKArray, beforeWarningsSDKArray, existingSDKWarnings, newSDKWarnings); - - console.log(`Config file: ${fileName}\n`) - console.log("SDK Errors/Warnings"); - console.log("==================="); - console.log("Errors: Before: ", beforeErrorsSDKArray.length, " - After: ", afterErrorsSDKArray.length); - console.log("Warnings: Before: ", beforeWarningsSDKArray.length, " - After: ", afterWarningsSDKArray.length); - console.log("New SDK Errors: ", newSDKErrors.length); - console.log("New SDK Warnings: ", newSDKWarnings.length); - console.log("Existing SDK Errors: ", existingSDKErrors.length); - console.log("Existing SDK Warnings: ", existingSDKWarnings.length); - console.log(); - console.log("ARM Errors/Warnings"); - console.log("==================="); - console.log("Errors: Before: ", beforeErrorsARMArray.length, " - After: ", afterErrorsARMArray.length); - console.log("Warnings: Before: ", beforeWarningsARMArray.length, " - After: ", afterWarningsARMArray.length); - console.log("New ARM Errors: ", newARMErrors.length); - console.log("New ARM Warnings: ", newARMWarnings.length); - console.log("Existing ARM Errors: ", existingARMErrors.length); - console.log("Existing ARM Warnings: ", existingARMWarnings.length); - console.log(); - - if (newSDKErrors.length > 0) { - console.log(`Potential new SDK errors`) - console.log("========================"); - console.log(getFileSummaryTable(newSDKErrors, "", potentialNewWarningErrorSummaryPlain)); - } - if (newSDKWarnings.length > 0) { - console.log(`Potential new SDK warnings`) - console.log("=========================="); - console.log(getFileSummaryTable(newSDKWarnings, "", potentialNewWarningErrorSummaryPlain)); - } - if (newARMErrors.length > 0) { - console.log(`Potential new ARM errors`) - console.log("========================"); - console.log(getFileSummaryTable(newARMErrors, "", potentialNewWarningErrorSummaryPlain)); - } - if (newARMWarnings.length > 0) { - console.log(`Potential new ARM warnings`) - console.log("=========================="); - console.log(getFileSummaryTable(newARMWarnings, "", potentialNewWarningErrorSummaryPlain)); - } - - console.log("-----------------------------------------\n") - - newSDKErrorsCount += newSDKErrors.length; - newARMErrorsCount += newARMErrors.length; - newSDKWarningsCount += newSDKWarnings.length; - newARMWarningsCount += newARMWarnings.length; - - sdkFileSummaries += getFileSummary("SDK", fileName, existingSDKWarnings, existingSDKErrors, newSDKWarnings, newSDKErrors); - armFileSummaries += getFileSummary("ARM", fileName, existingARMWarnings, existingARMErrors, newARMWarnings, newARMErrors); - } - - const sdkSummary = getSummaryBlock("SDK-related validation Errors / Warnings", sdkFileSummaries, sdkContactMessage); - const armSummary = getSummaryBlock("ARM-related validation Errors / Warnings", armFileSummaries, armContactMessage); - const text = `${sdkSummary}

\n\n${armSummary}

\n\n${githubFooter}`; - - const [title, summary] = getOutputMessages(newSDKErrorsCount, newARMErrorsCount, newSDKWarningsCount, newARMWarningsCount); - const output = { - title, - summary, - text: text.length <= 65535 ? text : `${tooManyResults}

\n\n${githubFooter}` - } - - console.log("---output"); - console.log(JSON.stringify(output, null, 2)); - console.log("---"); - - if(process.env.TRAVIS_REPO_SLUG != undefined && process.env.TRAVIS_REPO_SLUG.endsWith("-pr")) { - let slug = process.env.TRAVIS_REPO_SLUG; - slug = slug.split("/")[1]; - gitHubPost.postGithubComment("Azure", slug, pullRequestNumber, output.text); - } - - if (newSDKErrorsCount > 0 || newARMErrorsCount > 0) { - process.exitCode = 1; - } -} - -postProcessing(); diff --git a/scripts/momentOfTruthPostProcessing.ts b/scripts/momentOfTruthPostProcessing.ts new file mode 100644 index 000000000000..932bf87d5614 --- /dev/null +++ b/scripts/momentOfTruthPostProcessing.ts @@ -0,0 +1,6 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. See License.txt in the project root for license information. + +import { momentOfTruthPostProcessing } from '@azure/rest-api-specs-scripts' + +momentOfTruthPostProcessing.postProcessing(); diff --git a/scripts/multiapi.ts b/scripts/multiapi.ts index c7508904f776..f4d3f0493cc2 100644 --- a/scripts/multiapi.ts +++ b/scripts/multiapi.ts @@ -1,3 +1,6 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. See License.txt in the project root for license information. + import * as fs from "@ts-common/fs" import * as process from "process" import * as path from "path" diff --git a/scripts/postToGitHub.js b/scripts/postToGitHub.js deleted file mode 100644 index f162b6ad8b8a..000000000000 --- a/scripts/postToGitHub.js +++ /dev/null @@ -1,29 +0,0 @@ -// Copyright (c) Microsoft Corporation. All rights reserved. -// Licensed under the MIT License. See License.txt in the project root for license information. - -'use strict'; - -const octokit = require('@octokit/rest')(); -let token = process.env.GITHUB_TOKEN; - -if(token != undefined) { - octokit.authenticate({ - type: 'token', - token: token - }); -} - -module.exports = { - postGithubComment: function(owner, repository, prNumber, commentBody) { - octokit.issues.createComment({ - "owner": owner, - "repo": repository, - "number": prNumber, - "body": commentBody - }).then(data => { - console.log("Comment has been posted"); - }). catch(err => { - console.log(err); - }); - } -} \ No newline at end of file diff --git a/scripts/semanticValidation.js b/scripts/semanticValidation.js deleted file mode 100644 index f3c2f3d89de6..000000000000 --- a/scripts/semanticValidation.js +++ /dev/null @@ -1,26 +0,0 @@ -// Copyright (c) Microsoft Corporation. All rights reserved. -// Licensed under the MIT License. See License in the project root for license information. -'use strict'; - -const utils = require('../test/util/utils') -const oav = require('oav'); - -async function main() { - const swaggersToProcess = utils.getFilesChangedInPR(); - // Useful when debugging a test for a particular swagger. - // Just update the regex. That will return an array of filtered items. - // swaggersToProcess = swaggersToProcess.filter(function(item) { - // return (item.match(/.*Microsoft.Logic.*2016-06-01.*/ig) !== null); - // }); - for (const swagger of swaggersToProcess) { - try { - await oav.validateSpec(swagger, {consoleLogLevel: 'error', pretty: true}); - } catch (e) { - console.error("error: ") - console.error(e) - process.exitCode = 1 - } - } -} - -main().catch(e => { console.log(e); process.exit(1); }) \ No newline at end of file diff --git a/scripts/semanticValidation.ts b/scripts/semanticValidation.ts new file mode 100644 index 000000000000..e657bc580e99 --- /dev/null +++ b/scripts/semanticValidation.ts @@ -0,0 +1,6 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. See License in the project root for license information. + +import { semanticValidation } from '@azure/rest-api-specs-scripts' + +semanticValidation.main().catch(e => { console.log(e); process.exit(1); }) diff --git a/specification/addons/resource-manager/Microsoft.Addons/preview/2017-05-15/Addons.json b/specification/addons/resource-manager/Microsoft.Addons/preview/2017-05-15/Addons.json index e73eaabd55e1..a4e9517dd2d7 100644 --- a/specification/addons/resource-manager/Microsoft.Addons/preview/2017-05-15/Addons.json +++ b/specification/addons/resource-manager/Microsoft.Addons/preview/2017-05-15/Addons.json @@ -1,427 +1,444 @@ { - "swagger": "2.0", - "info": { - "title": "Azure Addons Resource Provider", - "description": "The service for managing third party addons.", - "version": "2017-05-15" - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "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" + "swagger": "2.0", + "info": { + "title": "Azure Addons Resource Provider", + "description": "The service for managing third party addons.", + "version": "2017-05-15" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "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.Addons/operations": { + "get": { + "tags": [ + "Operations" + ], + "operationId": "Operations_List", + "description": "Lists all of the available Addons RP operations.", + "x-ms-examples": { + "Operations_List": { + "$ref": "./examples/Operations_List.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "List all the operations.", + "schema": { + "$ref": "#/definitions/OperationList" } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/ErrorDefinition" + } + } } + } }, - "paths": { - "/providers/Microsoft.Addons/operations": { - "get": { - "tags": [ - "Operations" - ], - "operationId": "Operations_List", - "description": "Lists all of the available Addons RP operations.", - "x-ms-examples": { - "Operations_List": { - "$ref": "./examples/Operations_List.json" - } - }, - "parameters": [{ - "$ref": "#/parameters/ApiVersionParameter" - }], - "responses": { - "200": { - "description": "List all the operations.", - "schema": { - "$ref": "#/definitions/OperationList" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/ErrorDefinition" - } - } - } + "/subscriptions/{subscriptionId}/providers/Microsoft.Addons/supportProviders/{providerName}/supportPlanTypes/{planTypeName}": { + "get": { + "tags": [ + "AddonDetails" + ], + "operationId": "SupportPlanTypes_Get", + "description": "Returns whether or not the canonical support plan of type {type} is enabled for the subscription.", + "x-ms-examples": { + "SupportPlanTypes_Get": { + "$ref": "./examples/SupportPlanTypes_Get.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/SupportProviderName" + }, + { + "$ref": "#/parameters/CanonicalSupportPlanType" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CanonicalSupportPlanResponseEnvelope" + } + }, + "404": { + "description": "Not Found" + }, + "default": { + "description": "'404' - 'Not Found'.\n'400' - 'Bad Request'", + "schema": { + "$ref": "#/definitions/ErrorDefinition" } + } + } + }, + "put": { + "tags": [ + "AddonDetails" + ], + "operationId": "SupportPlanTypes_CreateOrUpdate", + "description": "Creates or updates the Canonical support plan of type {type} for the subscription.", + "x-ms-long-running-operation": true, + "x-ms-examples": { + "SupportPlanTypes_CreateOrUpdate": { + "$ref": "./examples/SupportPlanTypes_CreateOrUpdate.json" + } }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Addons/supportProviders/{providerName}/supportPlanTypes/{planTypeName}": { - "get": { - "tags": [ - "AddonDetails" - ], - "operationId": "SupportPlanTypes_Get", - "description": "Returns whether or not the canonical support plan of type {type} is enabled for the subscription.", - "x-ms-examples": { - "SupportPlanTypes_Get": { - "$ref": "./examples/SupportPlanTypes_Get.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/SupportProviderName" - }, - { - "$ref": "#/parameters/CanonicalSupportPlanType" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/CanonicalSupportPlanResponseEnvelope" - } - }, - "404": { - "description": "Not Found" - }, - "default": { - "description": "'404' - 'Not Found'.\n'400' - 'Bad Request'", - "schema": { - "$ref": "#/definitions/ErrorDefinition" - } - } - } - }, - "put": { - "tags": [ - "AddonDetails" - ], - "operationId": "SupportPlanTypes_CreateOrUpdate", - "description": "Creates or updates the Canonical support plan of type {type} for the subscription.", - "x-ms-long-running-operation": true, - "x-ms-examples": { - "SupportPlanTypes_CreateOrUpdate": { - "$ref": "./examples/SupportPlanTypes_CreateOrUpdate.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/SupportProviderName" - }, - { - "$ref": "#/parameters/CanonicalSupportPlanType" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/CanonicalSupportPlanResponseEnvelope" - } - }, - "201": { - "description": "Created", - "schema": { - "$ref": "#/definitions/CanonicalSupportPlanResponseEnvelope" - } - }, - "404": { - "description": "Not Found" - }, - "default": { - "description": "'404' - 'Not Found'.\n'400' - 'Bad Request'", - "schema": { - "$ref": "#/definitions/ErrorDefinition" - } - } - } - }, - "delete": { - "operationId": "SupportPlanTypes_Delete", - "description": "Cancels the Canonical support plan of type {type} for the subscription.", - "x-ms-long-running-operation": true, - "x-ms-examples": { - "SupportPlanTypes_Delete": { - "$ref": "./examples/SupportPlanTypes_Delete.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/SupportProviderName" - }, - { - "$ref": "#/parameters/CanonicalSupportPlanType" - } - ], - "responses": { - "202": { - "description": "Accepted", - "headers": { - }, - "schema": { - "$ref": "#/definitions/CanonicalSupportPlanResponseEnvelope" - } - }, - "204": { - "description": "No Content" - }, - "default": { - "description": "BadRequest", - "schema": { - "$ref": "#/definitions/ErrorDefinition" - } - } - } + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/SupportProviderName" + }, + { + "$ref": "#/parameters/CanonicalSupportPlanType" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CanonicalSupportPlanResponseEnvelope" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/CanonicalSupportPlanResponseEnvelope" + } + }, + "404": { + "description": "Not Found" + }, + "default": { + "description": "'404' - 'Not Found'.\n'400' - 'Bad Request'", + "schema": { + "$ref": "#/definitions/ErrorDefinition" } + } + } + }, + "delete": { + "operationId": "SupportPlanTypes_Delete", + "description": "Cancels the Canonical support plan of type {type} for the subscription.", + "x-ms-long-running-operation": true, + "x-ms-examples": { + "SupportPlanTypes_Delete": { + "$ref": "./examples/SupportPlanTypes_Delete.json" + } }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Addons/supportProviders/{providerName}/supportPlanTypes": { - "get": { - "tags": [ - "CanonicalSupportPlanStatus" - ], - "operationId": "CanonicalSupportPlanTypes_Get", - "summary": "Returns the Canonical Support Plans.", - "description": "Returns the Canonical Support Plans as well as whether they are enabled or not for the subscription.", - "x-ms-examples": { - "CanonicalSupportPlanTypes_Get": { - "$ref": "./examples/CanonicalSupportPlanTypes_Get.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/SupportProviderName" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/CanonicalSupportPlanStatus" - } - }, - "default": { - "description": "'404' - 'Not Found'.\n'400' - 'Bad Request'", - "schema": { - "$ref": "#/definitions/ErrorDefinition" - } - } - } + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/SupportProviderName" + }, + { + "$ref": "#/parameters/CanonicalSupportPlanType" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": {}, + "schema": { + "$ref": "#/definitions/CanonicalSupportPlanResponseEnvelope" + } + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "BadRequest", + "schema": { + "$ref": "#/definitions/ErrorDefinition" } + } } + } }, - "definitions": { - "CanonicalSupportPlanProperties": { - "type": "object", - "description": "The properties of the Canonical support plan.", - "properties": { - "provisioningState": { - "type": "string", - "description": "The provisioning state of the resource.", - "enum": ["Succeeded", "Failed", "Cancelled", "Purchasing", "Downgrading", "Cancelling", "Upgrading"], - "x-ms-enum": { - "name": "ProvisioningState", - "modelAsString": true - } - } - } - }, - "CanonicalSupportPlanResponseEnvelope": { - "type": "object", - "description": "The status of the Canonical support plan.", - "required": [ - "properties" - ], - "properties": { - "id": { - "readOnly": true, - "type": "string", - "description": "The id of the ARM resource, e.g. \"/subscriptions/{id}/providers/Microsoft.Addons/supportProvider/{supportProviderName}/supportPlanTypes/{planTypeName}\"." - }, - "name": { - "readOnly": true, - "type": "string", - "description": "The name of the Canonical support plan, i.e. \"essential\", \"standard\" or \"advanced\"." - }, - "type": { - "readOnly": true, - "type": "string", - "description": "Microsoft.Addons/supportProvider" - }, - "properties": { - "type": "object", - "$ref": "#/definitions/CanonicalSupportPlanProperties", - "description": "Describes Canonical support plan type and status.", - "x-ms-client-flatten": true - } - }, - "x-ms-azure-resource": true + "/subscriptions/{subscriptionId}/providers/Microsoft.Addons/supportProviders/{providerName}/supportPlanTypes": { + "get": { + "tags": [ + "CanonicalSupportPlanStatus" + ], + "operationId": "CanonicalSupportPlanTypes_Get", + "summary": "Returns the Canonical Support Plans.", + "description": "Returns the Canonical Support Plans as well as whether they are enabled or not for the subscription.", + "x-ms-examples": { + "CanonicalSupportPlanTypes_Get": { + "$ref": "./examples/CanonicalSupportPlanTypes_Get.json" + } }, - "CanonicalSupportPlanStatus" : { - "type": "array", - "title": "Canonical Support Plan Status", - "description": "Contains Canonical support plan status information.", - "items": { - "properties": { - "supportPlanType": { - "type": "string", - "description": "Support plan type.", - "enum": ["essential", "standard", "advanced"], - "x-ms-enum": { - "name": "SupportPlanType", - "modelAsString": true - } - }, - "enabled": { - "type": "boolean", - "description": "Whether the support plan is enabled for this subscription." - }, - "willEmitOneTimeChargeWhenEnabled": { - "type": "boolean", - "description": "This indicates that when this support plan is enabled if AddonsRP will emit a one-time charge." - }, - "willEmitOneTimeChargeIfReEnabled": { - "type": "boolean", - "description": "This indicates that when this support plan is cancelled and then enabled that AddonsRP will emit a one-time charge." - } - } - } - }, - "OperationList": { - "type": "array", - "description": "List of supported operations.", - "items": { - "$ref": "#/definitions/OperationsDefinition" + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/SupportProviderName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CanonicalSupportPlanStatus" } - }, - "OperationsDefinition": { - "type": "object", - "description": "Definition object with the name and properties of an operation.", - "properties": { - "name": { - "type": "string", - "description": "Name of the operation." - }, - "display": { - "$ref": "#/definitions/OperationsDisplayDefinition", - "description": "Display object with properties of the operation." - } + }, + "default": { + "description": "'404' - 'Not Found'.\n'400' - 'Bad Request'", + "schema": { + "$ref": "#/definitions/ErrorDefinition" } + } + } + } + } + }, + "definitions": { + "CanonicalSupportPlanProperties": { + "type": "object", + "description": "The properties of the Canonical support plan.", + "properties": { + "provisioningState": { + "type": "string", + "description": "The provisioning state of the resource.", + "enum": [ + "Succeeded", + "Failed", + "Cancelled", + "Purchasing", + "Downgrading", + "Cancelling", + "Upgrading" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + } + } + }, + "CanonicalSupportPlanResponseEnvelope": { + "type": "object", + "description": "The status of the Canonical support plan.", + "required": [ + "properties" + ], + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The id of the ARM resource, e.g. \"/subscriptions/{id}/providers/Microsoft.Addons/supportProvider/{supportProviderName}/supportPlanTypes/{planTypeName}\"." }, - "OperationsDisplayDefinition": { - "type": "object", - "description": "Display object with properties of the operation.", - "properties": { - "provider": { - "type": "string", - "description": "Resource provider of the operation." - }, - "resource": { - "type": "string", - "description": "Resource for the operation." - }, - "operation": { - "type": "string", - "description": "Short description of the operation." - }, - "description": { - "type": "string", - "description": "Description of the operation." - } - } + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the Canonical support plan, i.e. \"essential\", \"standard\" or \"advanced\"." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Microsoft.Addons/supportProvider" }, - "ErrorDefinition": { - "type": "object", - "title": "Error", - "description": "Error description and code explaining why an operation failed.", - "required": [ - "message", - "code" + "properties": { + "type": "object", + "$ref": "#/definitions/CanonicalSupportPlanProperties", + "description": "Describes Canonical support plan type and status.", + "x-ms-client-flatten": true + } + }, + "x-ms-azure-resource": true + }, + "CanonicalSupportPlanStatus": { + "type": "array", + "title": "Canonical Support Plan Status", + "description": "Contains Canonical support plan status information.", + "items": { + "properties": { + "supportPlanType": { + "type": "string", + "description": "Support plan type.", + "enum": [ + "essential", + "standard", + "advanced" ], - "properties": { - "message": { - "type": "string", - "description": "Description of the error." - }, - "code": { - "type": "integer", - "description": "Service specific error code which serves as the substatus for the HTTP error code.", - "minimum": 100, - "maximum": 600 - } + "x-ms-enum": { + "name": "SupportPlanType", + "modelAsString": true } + }, + "enabled": { + "type": "boolean", + "description": "Whether the support plan is enabled for this subscription." + }, + "willEmitOneTimeChargeWhenEnabled": { + "type": "boolean", + "description": "This indicates that when this support plan is enabled if AddonsRP will emit a one-time charge." + }, + "willEmitOneTimeChargeIfReEnabled": { + "type": "boolean", + "description": "This indicates that when this support plan is cancelled and then enabled that AddonsRP will emit a one-time charge." + } } + } }, - "parameters": { - "SubscriptionIdParameter": { - "name": "subscriptionId", - "in": "path", - "required": true, - "type": "string", - "description": "Subscription credentials that uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." + "OperationList": { + "type": "array", + "description": "List of supported operations.", + "items": { + "$ref": "#/definitions/OperationsDefinition" + } + }, + "OperationsDefinition": { + "type": "object", + "description": "Definition object with the name and properties of an operation.", + "properties": { + "name": { + "type": "string", + "description": "Name of the operation." }, - "ApiVersionParameter": { - "name": "api-version", - "in": "query", - "required": true, - "type": "string", - "description": "Client API version." + "display": { + "$ref": "#/definitions/OperationsDisplayDefinition", + "description": "Display object with properties of the operation." + } + } + }, + "OperationsDisplayDefinition": { + "type": "object", + "description": "Display object with properties of the operation.", + "properties": { + "provider": { + "type": "string", + "description": "Resource provider of the operation." }, - "SupportProviderName": { - "name": "providerName", - "in": "path", - "required": true, - "type": "string", - "description": "The support plan type. For now the only valid type is \"canonical\".", - "x-ms-parameter-location": "method" + "resource": { + "type": "string", + "description": "Resource for the operation." }, - "CanonicalSupportPlanType": { - "name": "planTypeName", - "in": "path", - "required": true, - "type": "string", - "description": "The Canonical support plan type.", - "enum": ["Essential", "Standard", "Advanced"], - "x-ms-enum": { - "name": "PlanTypeName", - "modelAsString": true - }, - "x-ms-parameter-location": "method" + "operation": { + "type": "string", + "description": "Short description of the operation." }, - "OperationResultsIdParameter": { - "name": "operationResultsId", - "in": "path", - "required": true, - "type": "string", - "description": "The id representing an async operation.", - "x-ms-parameter-location": "method" + "description": { + "type": "string", + "description": "Description of the operation." + } + } + }, + "ErrorDefinition": { + "type": "object", + "title": "Error", + "description": "Error description and code explaining why an operation failed.", + "required": [ + "message", + "code" + ], + "properties": { + "message": { + "type": "string", + "description": "Description of the error." + }, + "code": { + "type": "integer", + "description": "Service specific error code which serves as the substatus for the HTTP error code.", + "minimum": 100, + "maximum": 600 } + } + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "Subscription credentials that uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client API version." + }, + "SupportProviderName": { + "name": "providerName", + "in": "path", + "required": true, + "type": "string", + "description": "The support plan type. For now the only valid type is \"canonical\".", + "x-ms-parameter-location": "method" + }, + "CanonicalSupportPlanType": { + "name": "planTypeName", + "in": "path", + "required": true, + "type": "string", + "description": "The Canonical support plan type.", + "enum": [ + "Essential", + "Standard", + "Advanced" + ], + "x-ms-enum": { + "name": "PlanTypeName", + "modelAsString": true + }, + "x-ms-parameter-location": "method" + }, + "OperationResultsIdParameter": { + "name": "operationResultsId", + "in": "path", + "required": true, + "type": "string", + "description": "The id representing an async operation.", + "x-ms-parameter-location": "method" } + } } diff --git a/specification/addons/resource-manager/Microsoft.Addons/preview/2017-05-15/examples/CanonicalSupportPlanTypes_Get.json b/specification/addons/resource-manager/Microsoft.Addons/preview/2017-05-15/examples/CanonicalSupportPlanTypes_Get.json index d0536db09402..4828c4468f56 100644 --- a/specification/addons/resource-manager/Microsoft.Addons/preview/2017-05-15/examples/CanonicalSupportPlanTypes_Get.json +++ b/specification/addons/resource-manager/Microsoft.Addons/preview/2017-05-15/examples/CanonicalSupportPlanTypes_Get.json @@ -1,30 +1,31 @@ { - "parameters": { - "api-version": "2017-05-15", - "subscriptionId": "d18d258f-bdba-4de1-8b51-e79d6c181d5e", - "providerName": "Canonical" - }, - "responses": { - "200": { - "body": [{ - "enabled": true, - "supportPlanType": "standard", - "willEmitOneTimeChargeIfReEnabled": true, - "willEmitOneTimeChargeWhenEnabled": false - }, - { - "enabled": false, - "supportPlanType": "advanced", - "willEmitOneTimeChargeIfReEnabled": false, - "willEmitOneTimeChargeWhenEnabled": true - }, - { - "enabled": false, - "supportPlanType": "essential", - "willEmitOneTimeChargeIfReEnabled": false, - "willEmitOneTimeChargeWhenEnabled": false - } - ] + "parameters": { + "api-version": "2017-05-15", + "subscriptionId": "d18d258f-bdba-4de1-8b51-e79d6c181d5e", + "providerName": "Canonical" + }, + "responses": { + "200": { + "body": [ + { + "enabled": true, + "supportPlanType": "standard", + "willEmitOneTimeChargeIfReEnabled": true, + "willEmitOneTimeChargeWhenEnabled": false + }, + { + "enabled": false, + "supportPlanType": "advanced", + "willEmitOneTimeChargeIfReEnabled": false, + "willEmitOneTimeChargeWhenEnabled": true + }, + { + "enabled": false, + "supportPlanType": "essential", + "willEmitOneTimeChargeIfReEnabled": false, + "willEmitOneTimeChargeWhenEnabled": false } + ] } -} \ No newline at end of file + } +} diff --git a/specification/addons/resource-manager/Microsoft.Addons/preview/2017-05-15/examples/Operations_List.json b/specification/addons/resource-manager/Microsoft.Addons/preview/2017-05-15/examples/Operations_List.json index a4f43890ece9..b43f0323a561 100644 --- a/specification/addons/resource-manager/Microsoft.Addons/preview/2017-05-15/examples/Operations_List.json +++ b/specification/addons/resource-manager/Microsoft.Addons/preview/2017-05-15/examples/Operations_List.json @@ -1,54 +1,56 @@ { - "parameters": { - "api-version": "2017-05-15" - }, - "responses": { - "200": { - "body": [{ - "name": "Microsoft.Addons/supportProviders/supportPlanTypes/read", - "display": { - "provider": "Microsoft Addons", - "resource": "supportPlanTypes", - "operation": "Get Canonical support plan state", - "description": "Get the specified Canonical support plan state." - } - }, - { - "name": "Microsoft.Addons/supportProviders/supportPlanTypes/write", - "display": { - "provider": "Microsoft Addons", - "resource": "supportPlanTypes", - "operation": "Adds a Canonical support plan.", - "description": "Adds the Canonical support plan type specified." - } - }, - { - "name": "Microsoft.Addons/supportProviders/supportPlanTypes/delete", - "display": { - "provider": "Microsoft Addons", - "resource": "supportPlanTypes", - "operation": "Removes the Canonical support plan", - "description": "Removes the specified Canonical support plan" - } - }, - { - "name": "Microsoft.Addons/supportProviders/canonical/supportPlanTypes/get", - "display": { - "provider": "Microsoft Addons", - "resource": "supportProviders", - "operation": "Gets available Canonical support plan types.", - "description": "Gets the available Canonical support plan types as well as some extra metadata on their enabled status." - } - }, - { - "name": "Microsoft.Addons/register/action", - "display": { - "provider": "Microsoft Addons", - "resource": "register", - "operation": "Register for Microsoft.Addons", - "description": "Register the specified subscription with Microsoft.Addons" - } - }] + "parameters": { + "api-version": "2017-05-15" + }, + "responses": { + "200": { + "body": [ + { + "name": "Microsoft.Addons/supportProviders/supportPlanTypes/read", + "display": { + "provider": "Microsoft Addons", + "resource": "supportPlanTypes", + "operation": "Get Canonical support plan state", + "description": "Get the specified Canonical support plan state." + } + }, + { + "name": "Microsoft.Addons/supportProviders/supportPlanTypes/write", + "display": { + "provider": "Microsoft Addons", + "resource": "supportPlanTypes", + "operation": "Adds a Canonical support plan.", + "description": "Adds the Canonical support plan type specified." + } + }, + { + "name": "Microsoft.Addons/supportProviders/supportPlanTypes/delete", + "display": { + "provider": "Microsoft Addons", + "resource": "supportPlanTypes", + "operation": "Removes the Canonical support plan", + "description": "Removes the specified Canonical support plan" + } + }, + { + "name": "Microsoft.Addons/supportProviders/canonical/supportPlanTypes/get", + "display": { + "provider": "Microsoft Addons", + "resource": "supportProviders", + "operation": "Gets available Canonical support plan types.", + "description": "Gets the available Canonical support plan types as well as some extra metadata on their enabled status." + } + }, + { + "name": "Microsoft.Addons/register/action", + "display": { + "provider": "Microsoft Addons", + "resource": "register", + "operation": "Register for Microsoft.Addons", + "description": "Register the specified subscription with Microsoft.Addons" + } } + ] } -} \ No newline at end of file + } +} diff --git a/specification/addons/resource-manager/Microsoft.Addons/preview/2017-05-15/examples/SupportPlanTypes_CreateOrUpdate.json b/specification/addons/resource-manager/Microsoft.Addons/preview/2017-05-15/examples/SupportPlanTypes_CreateOrUpdate.json index 63d319e3010a..83f2534533eb 100644 --- a/specification/addons/resource-manager/Microsoft.Addons/preview/2017-05-15/examples/SupportPlanTypes_CreateOrUpdate.json +++ b/specification/addons/resource-manager/Microsoft.Addons/preview/2017-05-15/examples/SupportPlanTypes_CreateOrUpdate.json @@ -1,32 +1,31 @@ { - "parameters": { - "api-version": "2017-05-15", - "subscriptionId": "d18d258f-bdba-4de1-8b51-e79d6c181d5e", - "providerName": "Canonical", - "planTypeName": "Standard" - }, - "responses": { - "200": { - "body": { - "id": "subscriptions/d18d258f-bdba-4de1-8b51-e79d6c181d5e/providers/Microsoft.Addons/supportProviders/canonical/supportPlanTypes/Standard", - "name": "Standard", - "properties": { - "provisioningState": "Succeeded" - }, - "type": "Microsoft.Addons/supportProvider" - } + "parameters": { + "api-version": "2017-05-15", + "subscriptionId": "d18d258f-bdba-4de1-8b51-e79d6c181d5e", + "providerName": "Canonical", + "planTypeName": "Standard" + }, + "responses": { + "200": { + "body": { + "id": "subscriptions/d18d258f-bdba-4de1-8b51-e79d6c181d5e/providers/Microsoft.Addons/supportProviders/canonical/supportPlanTypes/Standard", + "name": "Standard", + "properties": { + "provisioningState": "Succeeded" }, - "201": { - "body": { - "id": "subscriptions/d18d258f-bdba-4de1-8b51-e79d6c181d5e/providers/Microsoft.Addons/supportProviders/canonical/supportPlanTypes/Standard", - "name": "Standard", - "properties": { - "provisioningState": "Purchasing" - }, - "type": "Microsoft.Addons/supportProvider" - } + "type": "Microsoft.Addons/supportProvider" + } + }, + "201": { + "body": { + "id": "subscriptions/d18d258f-bdba-4de1-8b51-e79d6c181d5e/providers/Microsoft.Addons/supportProviders/canonical/supportPlanTypes/Standard", + "name": "Standard", + "properties": { + "provisioningState": "Purchasing" }, - "404": { - } - } -} \ No newline at end of file + "type": "Microsoft.Addons/supportProvider" + } + }, + "404": {} + } +} diff --git a/specification/addons/resource-manager/Microsoft.Addons/preview/2017-05-15/examples/SupportPlanTypes_Delete.json b/specification/addons/resource-manager/Microsoft.Addons/preview/2017-05-15/examples/SupportPlanTypes_Delete.json index 7a19f0fe8f7c..0313d7ec7bcb 100644 --- a/specification/addons/resource-manager/Microsoft.Addons/preview/2017-05-15/examples/SupportPlanTypes_Delete.json +++ b/specification/addons/resource-manager/Microsoft.Addons/preview/2017-05-15/examples/SupportPlanTypes_Delete.json @@ -1,22 +1,21 @@ { - "parameters": { - "api-version": "2017-05-15", - "subscriptionId": "d18d258f-bdba-4de1-8b51-e79d6c181d5e", - "providerName": "Canonical", - "planTypeName": "Standard" - }, - "responses": { - "202": { - "body": { - "id": "subscriptions/d18d258f-bdba-4de1-8b51-e79d6c181d5e/providers/Microsoft.Addons/supportProviders/canonical/supportPlanTypes/Standard", - "name": "Standard", - "properties": { - "provisioningState": "Cancelling" - }, - "type": "Microsoft.Addons/supportProvider" - } + "parameters": { + "api-version": "2017-05-15", + "subscriptionId": "d18d258f-bdba-4de1-8b51-e79d6c181d5e", + "providerName": "Canonical", + "planTypeName": "Standard" + }, + "responses": { + "202": { + "body": { + "id": "subscriptions/d18d258f-bdba-4de1-8b51-e79d6c181d5e/providers/Microsoft.Addons/supportProviders/canonical/supportPlanTypes/Standard", + "name": "Standard", + "properties": { + "provisioningState": "Cancelling" }, - "204": { - } - } -} \ No newline at end of file + "type": "Microsoft.Addons/supportProvider" + } + }, + "204": {} + } +} diff --git a/specification/addons/resource-manager/Microsoft.Addons/preview/2017-05-15/examples/SupportPlanTypes_Get.json b/specification/addons/resource-manager/Microsoft.Addons/preview/2017-05-15/examples/SupportPlanTypes_Get.json index b62c2166c61a..a041806e8ef5 100644 --- a/specification/addons/resource-manager/Microsoft.Addons/preview/2017-05-15/examples/SupportPlanTypes_Get.json +++ b/specification/addons/resource-manager/Microsoft.Addons/preview/2017-05-15/examples/SupportPlanTypes_Get.json @@ -1,22 +1,21 @@ { - "parameters": { - "api-version": "2017-05-15", - "subscriptionId": "d18d258f-bdba-4de1-8b51-e79d6c181d5e", - "providerName": "Canonical", - "planTypeName": "Standard" - }, - "responses": { - "200": { - "body": { - "id": "subscriptions/d18d258f-bdba-4de1-8b51-e79d6c181d5e/providers/Microsoft.Addons/supportProviders/canonical/supportPlanTypes/Standard", - "name": "Standard", - "properties": { - "provisioningState": "Succeeded" - }, - "type": "Microsoft.Addons/supportProvider" - } + "parameters": { + "api-version": "2017-05-15", + "subscriptionId": "d18d258f-bdba-4de1-8b51-e79d6c181d5e", + "providerName": "Canonical", + "planTypeName": "Standard" + }, + "responses": { + "200": { + "body": { + "id": "subscriptions/d18d258f-bdba-4de1-8b51-e79d6c181d5e/providers/Microsoft.Addons/supportProviders/canonical/supportPlanTypes/Standard", + "name": "Standard", + "properties": { + "provisioningState": "Succeeded" }, - "404": { - } - } -} \ No newline at end of file + "type": "Microsoft.Addons/supportProvider" + } + }, + "404": {} + } +} diff --git a/specification/addons/resource-manager/Microsoft.Addons/preview/2018-03-01/addons-swagger.json b/specification/addons/resource-manager/Microsoft.Addons/preview/2018-03-01/addons-swagger.json index 333d8238eafd..62b473bf1191 100644 --- a/specification/addons/resource-manager/Microsoft.Addons/preview/2018-03-01/addons-swagger.json +++ b/specification/addons/resource-manager/Microsoft.Addons/preview/2018-03-01/addons-swagger.json @@ -180,8 +180,7 @@ "responses": { "202": { "description": "Accepted", - "headers": { - }, + "headers": {}, "schema": { "$ref": "#/definitions/CanonicalSupportPlanResponseEnvelope" } @@ -246,7 +245,15 @@ "provisioningState": { "type": "string", "description": "The provisioning state of the resource.", - "enum": [ "Succeeded", "Failed", "Cancelled", "Purchasing", "Downgrading", "Cancelling", "Upgrading" ], + "enum": [ + "Succeeded", + "Failed", + "Cancelled", + "Purchasing", + "Downgrading", + "Cancelling", + "Upgrading" + ], "x-ms-enum": { "name": "ProvisioningState", "modelAsString": true @@ -300,7 +307,11 @@ "supportPlanType": { "type": "string", "description": "Support plan type.", - "enum": [ "essential", "standard", "advanced" ], + "enum": [ + "essential", + "standard", + "advanced" + ], "x-ms-enum": { "name": "SupportPlanType", "modelAsString": true @@ -313,7 +324,11 @@ "oneTimeCharge": { "type": "string", "description": "The one time charge status for the subscription.", - "enum": [ "no", "onEnabled", "onReenabled" ], + "enum": [ + "no", + "onEnabled", + "onReenabled" + ], "x-ms-enum": { "name": "OneTimeCharge", "modelAsString": true @@ -415,7 +430,11 @@ "required": true, "type": "string", "description": "The Canonical support plan type.", - "enum": [ "Essential", "Standard", "Advanced" ], + "enum": [ + "Essential", + "Standard", + "Advanced" + ], "x-ms-enum": { "name": "PlanTypeName", "modelAsString": true @@ -431,4 +450,4 @@ "x-ms-parameter-location": "method" } } -} \ No newline at end of file +} diff --git a/specification/addons/resource-manager/Microsoft.Addons/preview/2018-03-01/examples/CanonicalListSupportPlanInfo_Post.json b/specification/addons/resource-manager/Microsoft.Addons/preview/2018-03-01/examples/CanonicalListSupportPlanInfo_Post.json index fe84ccca563c..90bc6bd218d2 100644 --- a/specification/addons/resource-manager/Microsoft.Addons/preview/2018-03-01/examples/CanonicalListSupportPlanInfo_Post.json +++ b/specification/addons/resource-manager/Microsoft.Addons/preview/2018-03-01/examples/CanonicalListSupportPlanInfo_Post.json @@ -1,29 +1,28 @@ { - "parameters": { - "api-version": "2018-03-01", - "subscriptionId": "d18d258f-bdba-4de1-8b51-e79d6c181d5e" - }, - "responses": { - "200": { - "body": [ - { - "oneTimeCharge": "onReenabled", - "supportPlanType": "standard", - "enabled": false - }, - { - "oneTimeCharge": "onReenabled", - "supportPlanType": "advanced", - "enabled": false - }, - { - "oneTimeCharge": "no", - "supportPlanType": "essential", - "enabled": true - } - ] + "parameters": { + "api-version": "2018-03-01", + "subscriptionId": "d18d258f-bdba-4de1-8b51-e79d6c181d5e" + }, + "responses": { + "200": { + "body": [ + { + "oneTimeCharge": "onReenabled", + "supportPlanType": "standard", + "enabled": false + }, + { + "oneTimeCharge": "onReenabled", + "supportPlanType": "advanced", + "enabled": false }, - "404": { + { + "oneTimeCharge": "no", + "supportPlanType": "essential", + "enabled": true } - } -} \ No newline at end of file + ] + }, + "404": {} + } +} diff --git a/specification/addons/resource-manager/Microsoft.Addons/preview/2018-03-01/examples/Operations_List.json b/specification/addons/resource-manager/Microsoft.Addons/preview/2018-03-01/examples/Operations_List.json index a4f43890ece9..b43f0323a561 100644 --- a/specification/addons/resource-manager/Microsoft.Addons/preview/2018-03-01/examples/Operations_List.json +++ b/specification/addons/resource-manager/Microsoft.Addons/preview/2018-03-01/examples/Operations_List.json @@ -1,54 +1,56 @@ { - "parameters": { - "api-version": "2017-05-15" - }, - "responses": { - "200": { - "body": [{ - "name": "Microsoft.Addons/supportProviders/supportPlanTypes/read", - "display": { - "provider": "Microsoft Addons", - "resource": "supportPlanTypes", - "operation": "Get Canonical support plan state", - "description": "Get the specified Canonical support plan state." - } - }, - { - "name": "Microsoft.Addons/supportProviders/supportPlanTypes/write", - "display": { - "provider": "Microsoft Addons", - "resource": "supportPlanTypes", - "operation": "Adds a Canonical support plan.", - "description": "Adds the Canonical support plan type specified." - } - }, - { - "name": "Microsoft.Addons/supportProviders/supportPlanTypes/delete", - "display": { - "provider": "Microsoft Addons", - "resource": "supportPlanTypes", - "operation": "Removes the Canonical support plan", - "description": "Removes the specified Canonical support plan" - } - }, - { - "name": "Microsoft.Addons/supportProviders/canonical/supportPlanTypes/get", - "display": { - "provider": "Microsoft Addons", - "resource": "supportProviders", - "operation": "Gets available Canonical support plan types.", - "description": "Gets the available Canonical support plan types as well as some extra metadata on their enabled status." - } - }, - { - "name": "Microsoft.Addons/register/action", - "display": { - "provider": "Microsoft Addons", - "resource": "register", - "operation": "Register for Microsoft.Addons", - "description": "Register the specified subscription with Microsoft.Addons" - } - }] + "parameters": { + "api-version": "2017-05-15" + }, + "responses": { + "200": { + "body": [ + { + "name": "Microsoft.Addons/supportProviders/supportPlanTypes/read", + "display": { + "provider": "Microsoft Addons", + "resource": "supportPlanTypes", + "operation": "Get Canonical support plan state", + "description": "Get the specified Canonical support plan state." + } + }, + { + "name": "Microsoft.Addons/supportProviders/supportPlanTypes/write", + "display": { + "provider": "Microsoft Addons", + "resource": "supportPlanTypes", + "operation": "Adds a Canonical support plan.", + "description": "Adds the Canonical support plan type specified." + } + }, + { + "name": "Microsoft.Addons/supportProviders/supportPlanTypes/delete", + "display": { + "provider": "Microsoft Addons", + "resource": "supportPlanTypes", + "operation": "Removes the Canonical support plan", + "description": "Removes the specified Canonical support plan" + } + }, + { + "name": "Microsoft.Addons/supportProviders/canonical/supportPlanTypes/get", + "display": { + "provider": "Microsoft Addons", + "resource": "supportProviders", + "operation": "Gets available Canonical support plan types.", + "description": "Gets the available Canonical support plan types as well as some extra metadata on their enabled status." + } + }, + { + "name": "Microsoft.Addons/register/action", + "display": { + "provider": "Microsoft Addons", + "resource": "register", + "operation": "Register for Microsoft.Addons", + "description": "Register the specified subscription with Microsoft.Addons" + } } + ] } -} \ No newline at end of file + } +} diff --git a/specification/addons/resource-manager/Microsoft.Addons/preview/2018-03-01/examples/SupportPlanTypes_CreateOrUpdate.json b/specification/addons/resource-manager/Microsoft.Addons/preview/2018-03-01/examples/SupportPlanTypes_CreateOrUpdate.json index 3ab6c201bf06..d25b9c229f80 100644 --- a/specification/addons/resource-manager/Microsoft.Addons/preview/2018-03-01/examples/SupportPlanTypes_CreateOrUpdate.json +++ b/specification/addons/resource-manager/Microsoft.Addons/preview/2018-03-01/examples/SupportPlanTypes_CreateOrUpdate.json @@ -1,32 +1,31 @@ { - "parameters": { - "api-version": "2018-03-01", - "subscriptionId": "d18d258f-bdba-4de1-8b51-e79d6c181d5e", - "providerName": "Canonical", - "planTypeName": "Standard" - }, - "responses": { - "200": { - "body": { - "properties": { - "provisioningState": "Succeeded" - }, - "id": "subscriptions/d18d258f-bdba-4de1-8b51-e79d6c181d5e/providers/Microsoft.Addons/supportProviders/canonical/supportPlanTypes/Standard", - "name": "Standard", - "type": "Microsoft.Addons/supportProvider" - } + "parameters": { + "api-version": "2018-03-01", + "subscriptionId": "d18d258f-bdba-4de1-8b51-e79d6c181d5e", + "providerName": "Canonical", + "planTypeName": "Standard" + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded" }, - "201": { - "body": { - "properties": { - "provisioningState": "Purchasing" - }, - "id": "subscriptions/d18d258f-bdba-4de1-8b51-e79d6c181d5e/providers/Microsoft.Addons/supportProviders/canonical/supportPlanTypes/Standard", - "name": "Standard", - "type": "Microsoft.Addons/supportProvider" - } + "id": "subscriptions/d18d258f-bdba-4de1-8b51-e79d6c181d5e/providers/Microsoft.Addons/supportProviders/canonical/supportPlanTypes/Standard", + "name": "Standard", + "type": "Microsoft.Addons/supportProvider" + } + }, + "201": { + "body": { + "properties": { + "provisioningState": "Purchasing" }, - "404": { - } - } -} \ No newline at end of file + "id": "subscriptions/d18d258f-bdba-4de1-8b51-e79d6c181d5e/providers/Microsoft.Addons/supportProviders/canonical/supportPlanTypes/Standard", + "name": "Standard", + "type": "Microsoft.Addons/supportProvider" + } + }, + "404": {} + } +} diff --git a/specification/addons/resource-manager/Microsoft.Addons/preview/2018-03-01/examples/SupportPlanTypes_Delete.json b/specification/addons/resource-manager/Microsoft.Addons/preview/2018-03-01/examples/SupportPlanTypes_Delete.json index 58482e1ebeab..e376b2935c5d 100644 --- a/specification/addons/resource-manager/Microsoft.Addons/preview/2018-03-01/examples/SupportPlanTypes_Delete.json +++ b/specification/addons/resource-manager/Microsoft.Addons/preview/2018-03-01/examples/SupportPlanTypes_Delete.json @@ -1,22 +1,21 @@ { - "parameters": { - "api-version": "2018-03-01", - "subscriptionId": "d18d258f-bdba-4de1-8b51-e79d6c181d5e", - "providerName": "Canonical", - "planTypeName": "Standard" - }, - "responses": { - "202": { - "body": { - "properties": { - "provisioningState": "Cancelling" - }, - "id": "subscriptions/d18d258f-bdba-4de1-8b51-e79d6c181d5e/providers/Microsoft.Addons/supportProviders/canonical/supportPlanTypes/Standard", - "name": "Standard", - "type": "Microsoft.Addons/supportProvider" - } + "parameters": { + "api-version": "2018-03-01", + "subscriptionId": "d18d258f-bdba-4de1-8b51-e79d6c181d5e", + "providerName": "Canonical", + "planTypeName": "Standard" + }, + "responses": { + "202": { + "body": { + "properties": { + "provisioningState": "Cancelling" }, - "204": { - } - } -} \ No newline at end of file + "id": "subscriptions/d18d258f-bdba-4de1-8b51-e79d6c181d5e/providers/Microsoft.Addons/supportProviders/canonical/supportPlanTypes/Standard", + "name": "Standard", + "type": "Microsoft.Addons/supportProvider" + } + }, + "204": {} + } +} diff --git a/specification/addons/resource-manager/Microsoft.Addons/preview/2018-03-01/examples/SupportPlanTypes_Get.json b/specification/addons/resource-manager/Microsoft.Addons/preview/2018-03-01/examples/SupportPlanTypes_Get.json index 84eb7dcedc4e..fa6e94768844 100644 --- a/specification/addons/resource-manager/Microsoft.Addons/preview/2018-03-01/examples/SupportPlanTypes_Get.json +++ b/specification/addons/resource-manager/Microsoft.Addons/preview/2018-03-01/examples/SupportPlanTypes_Get.json @@ -1,22 +1,21 @@ { - "parameters": { - "api-version": "2018-03-01", - "subscriptionId": "d18d258f-bdba-4de1-8b51-e79d6c181d5e", - "providerName": "Canonical", - "planTypeName": "Standard" - }, - "responses": { - "200": { - "body": { - "properties": { - "provisioningState": "Succeeded" - }, - "id": "subscriptions/d18d258f-bdba-4de1-8b51-e79d6c181d5e/providers/Microsoft.Addons/supportProviders/canonical/supportPlanTypes/Standard", - "name": "Standard", - "type": "Microsoft.Addons/supportProvider" - } + "parameters": { + "api-version": "2018-03-01", + "subscriptionId": "d18d258f-bdba-4de1-8b51-e79d6c181d5e", + "providerName": "Canonical", + "planTypeName": "Standard" + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded" }, - "404": { - } - } -} \ No newline at end of file + "id": "subscriptions/d18d258f-bdba-4de1-8b51-e79d6c181d5e/providers/Microsoft.Addons/supportProviders/canonical/supportPlanTypes/Standard", + "name": "Standard", + "type": "Microsoft.Addons/supportProvider" + } + }, + "404": {} + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2019-01-01/apimanagement.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2019-01-01/apimanagement.json index 2b81dc083327..7aae28c6cdcc 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2019-01-01/apimanagement.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2019-01-01/apimanagement.json @@ -482,6 +482,33 @@ "pattern": "^[^*#&+:<>?]+$", "x-ms-parameter-location": "method" }, + "PolicyExportFormat": { + "name": "format", + "in": "query", + "required": false, + "type": "string", + "description": "Policy Export Format.", + "enum": [ + "xml", + "rawxml" + ], + "x-ms-enum": { + "name": "PolicyExportFormat", + "modelAsString": true, + "values": [ + { + "value": "xml", + "description": "The contents are inline and Content type is an XML document." + }, + { + "value": "rawxml", + "description": "The contents are inline and Content type is a non XML encoded policy document." + } + ] + }, + "default": "xml", + "x-ms-parameter-location": "method" + }, "PolicyIdParameter": { "name": "policyId", "in": "path", diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2019-01-01/apimapis.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2019-01-01/apimapis.json index 3301aa84b12d..4be9ae56fea6 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2019-01-01/apimapis.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2019-01-01/apimapis.json @@ -1314,6 +1314,9 @@ { "$ref": "./apimanagement.json#/parameters/OperationIdParameter" }, + { + "$ref": "./apimanagement.json#/parameters/PolicyExportFormat" + }, { "$ref": "./apimanagement.json#/parameters/PolicyIdParameter" }, @@ -1941,6 +1944,9 @@ { "$ref": "./apimanagement.json#/parameters/PolicyIdParameter" }, + { + "$ref": "./apimanagement.json#/parameters/PolicyExportFormat" + }, { "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" }, diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2019-01-01/apimpolicies.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2019-01-01/apimpolicies.json index c39cc1169ffd..e8adcb8daf7b 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2019-01-01/apimpolicies.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2019-01-01/apimpolicies.json @@ -132,6 +132,9 @@ "x-ms-examples": { "ApiManagementGetPolicy": { "$ref": "./examples/ApiManagementGetPolicy.json" + }, + "ApiManagementGetPolicyFormat": { + "$ref": "./examples/ApiManagementGetPolicyFormat.json" } }, "parameters": [ @@ -144,6 +147,9 @@ { "$ref": "./apimanagement.json#/parameters/PolicyIdParameter" }, + { + "$ref": "./apimanagement.json#/parameters/PolicyExportFormat" + }, { "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" }, diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2019-01-01/apimproducts.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2019-01-01/apimproducts.json index e4eba0669ff8..beb2a6de8176 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2019-01-01/apimproducts.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2019-01-01/apimproducts.json @@ -973,6 +973,9 @@ { "$ref": "./apimanagement.json#/parameters/PolicyIdParameter" }, + { + "$ref": "./apimanagement.json#/parameters/PolicyExportFormat" + }, { "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" }, diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2019-01-01/examples/ApiManagementCreateApiRevisionFromExistingApi.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2019-01-01/examples/ApiManagementCreateApiRevisionFromExistingApi.json index 5dd4116bc93f..cf929153ea59 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2019-01-01/examples/ApiManagementCreateApiRevisionFromExistingApi.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2019-01-01/examples/ApiManagementCreateApiRevisionFromExistingApi.json @@ -4,37 +4,29 @@ "resourceGroupName": "rg1", "api-version": "2019-01-01", "subscriptionId": "subid", - "apiId": "echo-api;rev=2", + "apiId": "echo-api;rev=3", "parameters": { "properties": { - "displayName": "httpbin", - "description": "Existing Http Bin Api", - "serviceUrl": "http://httpbin.org", - "path": "bin", - "protocols": [ - "http", - "https" - ], - "sourceApiId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/59793a3c4679c754636c520e", - "apiRevisionDescription": "Creating a Revision of an existing API", - "isCurrent": false + "path": "echo", + "serviceUrl": "http://echoapi.cloudapp.net/apiv3", + "sourceApiId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api", + "apiRevisionDescription": "Creating a Revision of an existing API" } } }, "responses": { "201": { "body": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/59793a3c4679c754636c520e;rev=2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api;rev=3", "type": "Microsoft.ApiManagement/service/apis", - "name": "59793a3c4679c754636c520e;rev=2", + "name": "echo-api;rev=3", "properties": { - "displayName": "httpbin", - "apiRevision": "2", - "description": "", - "serviceUrl": "http://httpbin.org", - "path": "bin", + "displayName": "Echo API", + "apiRevision": "3", + "subscriptionRequired": true, + "serviceUrl": "http://echoapi.cloudapp.net/apiv3", + "path": "echo", "protocols": [ - "http", "https" ], "subscriptionKeyParameterNames": { @@ -52,17 +44,16 @@ }, "200": { "body": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/59793a3c4679c754636c520e;rev=2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api;rev=3", "type": "Microsoft.ApiManagement/service/apis", - "name": "59793a3c4679c754636c520e;rev=2", + "name": "echo-api;rev=3", "properties": { - "displayName": "httpbin", - "apiRevision": "2", - "description": "", - "serviceUrl": "http://httpbin.org", - "path": "bin", + "displayName": "Echo API", + "apiRevision": "3", + "subscriptionRequired": true, + "serviceUrl": "http://echoapi.cloudapp.net/apiv3", + "path": "echo", "protocols": [ - "http", "https" ], "subscriptionKeyParameterNames": { diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2019-01-01/examples/ApiManagementGetPolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2019-01-01/examples/ApiManagementGetPolicy.json index c779a97ad1cf..5178f5ea3699 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2019-01-01/examples/ApiManagementGetPolicy.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2019-01-01/examples/ApiManagementGetPolicy.json @@ -1,21 +1,21 @@ { - "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", - "api-version": "2019-01-01", - "subscriptionId": "subid", - "policyId": "policy" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policies/policy", - "type": "Microsoft.ApiManagement/service/policies", - "name": "policy", - "properties": { - "value": "\r\n\r\n \r\n \r\n \r\n \r\n \r\n" - } - } + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2019-01-01", + "subscriptionId": "subid", + "policyId": "policy" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policies/policy", + "type": "Microsoft.ApiManagement/service/policies", + "name": "policy", + "properties": { + "value": "\r\n\r\n \r\n \r\n \r\n \r\n \r\n" } + } } + } } \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2019-01-01/examples/ApiManagementGetPolicyFormat.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2019-01-01/examples/ApiManagementGetPolicyFormat.json new file mode 100644 index 000000000000..a968a51ff5f4 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2019-01-01/examples/ApiManagementGetPolicyFormat.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2019-01-01", + "subscriptionId": "subid", + "policyId": "policy", + "format": "rawxml" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policies/policy", + "type": "Microsoft.ApiManagement/service/policies", + "name": "policy", + "properties": { + "format": "rawxml", + "value": "\r\n\r\n\t\r\n\t\t\r\n\t\t\t@{\n var guidBinary = new byte[16];\n Array.Copy(Guid.NewGuid().ToByteArray(), 0, guidBinary, 0, 10);\n long time = DateTime.Now.Ticks;\n byte[] bytes = new byte[6];\n unchecked\n {\n bytes[5] = (byte)(time >> 40);\n bytes[4] = (byte)(time >> 32);\n bytes[3] = (byte)(time >> 24);\n bytes[2] = (byte)(time >> 16);\n bytes[1] = (byte)(time >> 8);\n bytes[0] = (byte)(time);\n }\n Array.Copy(bytes, 0, guidBinary, 10, 6);\n return new Guid(guidBinary).ToString();\n }\n \r\n\t\t\r\n\t\r\n\t\r\n\t\t\r\n\t\r\n\t\r\n\t\r\n" + } + } + } + } +} \ No newline at end of file diff --git a/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/preview/2019-02-01-preview/appconfiguration.json b/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/preview/2019-02-01-preview/appconfiguration.json new file mode 100644 index 000000000000..4b7462791a51 --- /dev/null +++ b/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/preview/2019-02-01-preview/appconfiguration.json @@ -0,0 +1,866 @@ +{ + "swagger": "2.0", + "info": { + "version": "2019-02-01-preview", + "title": "AppConfigurationManagementClient" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.AppConfiguration/configurationStores": { + "get": { + "tags": [ + "ConfigurationStores" + ], + "description": "Lists the configuration stores for a given subscription.", + "operationId": "ConfigurationStores_List", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "$skipToken", + "in": "query", + "description": "A skip token is used to continue retrieving items after an operation returns a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skipToken parameter that specifies a starting point to use for subsequent calls.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/ConfigurationStoreListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "ConfigurationStores_List": { + "$ref": "./examples/ConfigurationStoresList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppConfiguration/configurationStores": { + "get": { + "tags": [ + "ConfigurationStores" + ], + "description": "Lists the configuration stores for a given resource group.", + "operationId": "ConfigurationStores_ListByResourceGroup", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "$skipToken", + "in": "query", + "description": "A skip token is used to continue retrieving items after an operation returns a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skipToken parameter that specifies a starting point to use for subsequent calls.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/ConfigurationStoreListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "ConfigurationStores_ListByResourceGroup": { + "$ref": "./examples/ConfigurationStoresListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppConfiguration/configurationStores/{configStoreName}": { + "get": { + "tags": [ + "ConfigurationStores" + ], + "description": "Gets the properties of the specified configuration store.", + "operationId": "ConfigurationStores_Get", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ConfigStoreNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/ConfigurationStore" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "ConfigurationStores_Get": { + "$ref": "./examples/ConfigurationStoresGet.json" + } + } + }, + "put": { + "tags": [ + "ConfigurationStores" + ], + "description": "Creates a configuration store with the specified parameters.", + "operationId": "ConfigurationStores_Create", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ConfigStoreNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "configStoreCreationParameters", + "in": "body", + "description": "The parameters for creating a configuration store.", + "required": true, + "schema": { + "$ref": "#/definitions/ConfigurationStore" + } + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/ConfigurationStore" + } + }, + "201": { + "description": "The request was successfully accepted; the operation will complete asynchronously. The provisioning state of the resource should indicate the current state of the resource.", + "schema": { + "$ref": "#/definitions/ConfigurationStore" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "ConfigurationStores_Create": { + "$ref": "./examples/ConfigurationStoresCreate.json" + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "ConfigurationStores" + ], + "description": "Deletes a configuration store.", + "operationId": "ConfigurationStores_Delete", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ConfigStoreNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly." + }, + "202": { + "description": "The request was successful; the operation will complete asynchronously." + }, + "204": { + "description": "No Content - the specified resource was not found." + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "ConfigurationStores_Delete": { + "$ref": "./examples/ConfigurationStoresDelete.json" + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "ConfigurationStores" + ], + "description": "Updates a configuration store with the specified parameters.", + "operationId": "ConfigurationStores_Update", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ConfigStoreNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "configStoreUpdateParameters", + "in": "body", + "description": "The parameters for updating a configuration store.", + "required": true, + "schema": { + "$ref": "#/definitions/ConfigurationStoreUpdateParameters" + } + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/ConfigurationStore" + } + }, + "201": { + "description": "The request was successfully accepted; the operation will complete asynchronously. The provisioning state of the resource should indicate the current state of the resource.", + "schema": { + "$ref": "#/definitions/ConfigurationStore" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "ConfigurationStores_Update": { + "$ref": "./examples/ConfigurationStoresUpdate.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.AppConfiguration/checkNameAvailability": { + "post": { + "tags": [ + "Operations" + ], + "description": "Checks whether the configuration store name is available for use.", + "operationId": "Operations_CheckNameAvailability", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "checkNameAvailabilityParameters", + "in": "body", + "description": "The object containing information for the availability request.", + "required": true, + "schema": { + "$ref": "#/definitions/CheckNameAvailabilityParameters" + } + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/NameAvailabilityStatus" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "ConfigurationStores_CheckNameAvailable": { + "$ref": "./examples/CheckNameAvailable.json" + }, + "ConfigurationStores_CheckNameNotAvailable": { + "$ref": "./examples/CheckNameNotAvailable.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppConfiguration/configurationStores/{configStoreName}/ListKeys": { + "post": { + "tags": [ + "ConfigurationStores" + ], + "description": "Lists the access key for the specified configuration store.", + "operationId": "ConfigurationStores_ListKeys", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ConfigStoreNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "$skipToken", + "in": "query", + "description": "A skip token is used to continue retrieving items after an operation returns a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skipToken parameter that specifies a starting point to use for subsequent calls.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/ApiKeyListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "ConfigurationStores_ListKeys": { + "$ref": "./examples/ConfigurationStoresListKeys.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppConfiguration/configurationStores/{configStoreName}/RegenerateKey": { + "post": { + "tags": [ + "ConfigurationStores" + ], + "description": "Regenerates an access key for the specified configuration store.", + "operationId": "ConfigurationStores_RegenerateKey", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ConfigStoreNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "regenerateKeyParameters", + "in": "body", + "description": "The parameters for regenerating an access key.", + "required": true, + "schema": { + "$ref": "#/definitions/RegenerateKeyParameters" + } + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/ApiKey" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "ConfigurationStores_RegenerateKey": { + "$ref": "./examples/ConfigurationStoresRegenerateKey.json" + } + } + } + }, + "/providers/Microsoft.AppConfiguration/operations": { + "get": { + "tags": [ + "Operations" + ], + "description": "Lists the operations available from this provider.", + "operationId": "Operations_List", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "$skipToken", + "in": "query", + "description": "A skip token is used to continue retrieving items after an operation returns a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skipToken parameter that specifies a starting point to use for subsequent calls.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/OperationDefinitionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": {}, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "ConfigurationStoreListResult": { + "description": "The result of a request to list configuration stores.", + "type": "object", + "properties": { + "value": { + "description": "The collection value.", + "type": "array", + "items": { + "$ref": "#/definitions/ConfigurationStore" + } + }, + "nextLink": { + "description": "The URI that can be used to request the next set of paged results.", + "type": "string" + } + } + }, + "ConfigurationStore": { + "description": "The configuration store along with all resource properties. The Configuration Store will have all information to begin utilizing it.", + "required": [ + "location" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/ConfigurationStoreProperties", + "description": "The properties of a configuration store.", + "x-ms-client-flatten": true + } + } + }, + "ConfigurationStoreProperties": { + "description": "The properties of a configuration store.", + "type": "object", + "properties": { + "provisioningState": { + "description": "The provisioning state of the configuration store.", + "enum": [ + "Creating", + "Updating", + "Deleting", + "Succeeded", + "Failed", + "Canceled" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + }, + "creationDate": { + "format": "date-time", + "description": "The creation date of configuration store.", + "type": "string", + "readOnly": true + }, + "endpoint": { + "description": "The DNS endpoint where the configuration store API will be available.", + "type": "string", + "readOnly": true + } + } + }, + "ConfigurationStoreUpdateParameters": { + "description": "The parameters for updating a configuration store.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/ConfigurationStorePropertiesUpdateParameters", + "description": "The properties for updating a configuration store.", + "x-ms-client-flatten": true + }, + "tags": { + "description": "The ARM resource tags.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "ConfigurationStorePropertiesUpdateParameters": { + "description": "The properties for updating a configuration store.", + "type": "object", + "properties": {} + }, + "CheckNameAvailabilityParameters": { + "description": "Parameters used for checking whether a resource name is available.", + "required": [ + "name", + "type" + ], + "type": "object", + "properties": { + "name": { + "description": "The name to check for availability.", + "type": "string" + }, + "type": { + "description": "The resource type to check for name availability.", + "enum": [ + "Microsoft.AppConfiguration/configurationStores" + ], + "type": "string", + "x-ms-enum": { + "name": "ConfigurationResourceType", + "modelAsString": true + } + } + } + }, + "NameAvailabilityStatus": { + "description": "The result of a request to check the availability of a resource name.", + "type": "object", + "properties": { + "nameAvailable": { + "description": "The value indicating whether the resource name is available.", + "type": "boolean", + "readOnly": true + }, + "message": { + "description": "If any, the error message that provides more detail for the reason that the name is not available.", + "type": "string", + "readOnly": true + }, + "reason": { + "description": "If any, the reason that the name is not available.", + "type": "string", + "readOnly": true + } + } + }, + "ApiKeyListResult": { + "description": "The result of a request to list API keys.", + "type": "object", + "properties": { + "value": { + "description": "The collection value.", + "type": "array", + "items": { + "$ref": "#/definitions/ApiKey" + } + }, + "nextLink": { + "description": "The URI that can be used to request the next set of paged results.", + "type": "string" + } + } + }, + "ApiKey": { + "description": "An API key used for authenticating with a configuration store endpoint.", + "type": "object", + "properties": { + "id": { + "description": "The key ID.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "A name for the key describing its usage.", + "type": "string", + "readOnly": true + }, + "value": { + "description": "The value of the key that is used for authentication purposes.", + "type": "string", + "readOnly": true + }, + "connectionString": { + "description": "A connection string that can be used by supporting clients for authentication.", + "type": "string", + "readOnly": true + }, + "lastModified": { + "format": "date-time", + "description": "The last time any of the key's properties were modified.", + "type": "string", + "readOnly": true + }, + "readOnly": { + "description": "Whether this key can only be used for read operations.", + "type": "boolean", + "readOnly": true + } + } + }, + "RegenerateKeyParameters": { + "description": "The parameters used to regenerate an API key.", + "type": "object", + "properties": { + "id": { + "description": "The id of the key to regenerate.", + "type": "string" + } + } + }, + "OperationDefinitionListResult": { + "description": "The result of a request to list configuration store operations.", + "type": "object", + "properties": { + "value": { + "description": "The collection value.", + "type": "array", + "items": { + "$ref": "#/definitions/OperationDefinition" + } + }, + "nextLink": { + "description": "The URI that can be used to request the next set of paged results.", + "type": "string" + } + } + }, + "OperationDefinition": { + "description": "The definition of a configuration store operation.", + "type": "object", + "properties": { + "name": { + "description": "Operation name: {provider}/{resource}/{operation}.", + "type": "string" + }, + "display": { + "$ref": "#/definitions/OperationDefinitionDisplay", + "description": "The display information for the configuration store operation." + } + } + }, + "OperationDefinitionDisplay": { + "description": "The display information for a configuration store operation.", + "type": "object", + "properties": { + "provider": { + "description": "The resource provider name: Microsoft App Configuration.\"", + "type": "string", + "readOnly": true + }, + "resource": { + "description": "The resource on which the operation is performed.", + "type": "string" + }, + "operation": { + "description": "The operation that users can perform.", + "type": "string" + }, + "description": { + "description": "The description for the operation.", + "type": "string" + } + } + }, + "Error": { + "description": "AppConfiguration error object.", + "properties": { + "code": { + "description": "Error code.", + "type": "string" + }, + "message": { + "description": "Error message.", + "type": "string" + } + } + }, + "Resource": { + "description": "An Azure resource.", + "required": [ + "location" + ], + "properties": { + "id": { + "description": "The resource ID.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The name of the resource.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "The type of the resource.", + "type": "string", + "readOnly": true + }, + "location": { + "description": "The location of the resource. This cannot be changed after the resource is created.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "tags": { + "description": "The tags of the resource.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + }, + "x-ms-azure-resource": true + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "description": "The Microsoft Azure subscription ID.", + "required": true, + "type": "string" + }, + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group to which the container registry belongs.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ConfigStoreNameParameter": { + "name": "configStoreName", + "in": "path", + "description": "The name of the configuration store.", + "required": true, + "type": "string", + "maxLength": 50, + "minLength": 5, + "pattern": "^[a-zA-Z0-9_-]*$", + "x-ms-parameter-location": "method" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "The client API version.", + "required": true, + "type": "string" + } + }, + "securityDefinitions": { + "azure_auth": { + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + }, + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow" + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] +} \ No newline at end of file diff --git a/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/preview/2019-02-01-preview/examples/CheckNameAvailable.json b/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/preview/2019-02-01-preview/examples/CheckNameAvailable.json new file mode 100644 index 000000000000..8669d4f08113 --- /dev/null +++ b/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/preview/2019-02-01-preview/examples/CheckNameAvailable.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "c80fb759-c965-4c6a-9110-9b2b2d038882", + "api-version": "2019-02-01-preview", + "checkNameAvailabilityParameters": { + "name": "fayeh", + "type": "Microsoft.AppConfiguration/configurationStores" + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": true, + "message": "The specified name is available.", + "reason": null + } + } + } +} \ No newline at end of file diff --git a/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/preview/2019-02-01-preview/examples/CheckNameNotAvailable.json b/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/preview/2019-02-01-preview/examples/CheckNameNotAvailable.json new file mode 100644 index 000000000000..36b88c96f40f --- /dev/null +++ b/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/preview/2019-02-01-preview/examples/CheckNameNotAvailable.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "c80fb759-c965-4c6a-9110-9b2b2d038882", + "api-version": "2019-02-01-preview", + "checkNameAvailabilityParameters": { + "name": "fayeh", + "type": "Microsoft.AppConfiguration/configurationStores" + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": false, + "reason": "AlreadyExists", + "message": "The specified name is already in use." + } + } + } +} \ No newline at end of file diff --git a/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/preview/2019-02-01-preview/examples/ConfigurationStoresCreate.json b/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/preview/2019-02-01-preview/examples/ConfigurationStoresCreate.json new file mode 100644 index 000000000000..2edfd7abad25 --- /dev/null +++ b/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/preview/2019-02-01-preview/examples/ConfigurationStoresCreate.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "subscriptionId": "c80fb759-c965-4c6a-9110-9b2b2d038882", + "resourceGroupName": "myResourceGroup", + "configStoreName": "fayeh", + "api-version": "2019-02-01-preview", + "configStoreCreationParameters": { + "location": "westus", + "tags": { + "myTag": "myTagValue" + } + } + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.AppConfiguration/configurationStores", + "properties": { + "provisioningState": "Succeeded", + "creationDate": "2018-04-24T16:30:55+00:00", + "endpoint": "https://fayeh.azconfig.io" + }, + "id": "/subscriptions/c80fb759-c965-4c6a-9110-9b2b2d038882/resourceGroups/myResourceGroup/providers/Microsoft.AppConfiguration/configurationStores/fayeh", + "name": "fayeh", + "location": "westus", + "tags": { + "myTag": "myTagValue" + } + } + }, + "201": { + "body": { + "type": "Microsoft.AppConfiguration/configurationStores", + "properties": { + "provisioningState": "Creating", + "creationDate": "2018-04-24T16:30:55+00:00", + "endpoint": "https://fayeh.azconfig.io" + }, + "id": "/subscriptions/c80fb759-c965-4c6a-9110-9b2b2d038882/resourceGroups/myResourceGroup/providers/Microsoft.AppConfiguration/configurationStores/fayeh", + "name": "fayeh", + "location": "westus", + "tags": { + "myTag": "myTagValue" + } + } + } + } +} \ No newline at end of file diff --git a/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/preview/2019-02-01-preview/examples/ConfigurationStoresDelete.json b/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/preview/2019-02-01-preview/examples/ConfigurationStoresDelete.json new file mode 100644 index 000000000000..ebcc06e99d74 --- /dev/null +++ b/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/preview/2019-02-01-preview/examples/ConfigurationStoresDelete.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "subscriptionId": "c80fb759-c965-4c6a-9110-9b2b2d038882", + "resourceGroupName": "myResourceGroup", + "configStoreName": "fayeh", + "api-version": "2019-02-01-preview" + }, + "responses": { + "200": { + }, + "202": { + }, + "204": { + } + } +} diff --git a/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/preview/2019-02-01-preview/examples/ConfigurationStoresGet.json b/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/preview/2019-02-01-preview/examples/ConfigurationStoresGet.json new file mode 100644 index 000000000000..69bf90ec2b95 --- /dev/null +++ b/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/preview/2019-02-01-preview/examples/ConfigurationStoresGet.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "c80fb759-c965-4c6a-9110-9b2b2d038882", + "resourceGroupName": "myResourceGroup", + "configStoreName": "fayeh", + "api-version": "2019-02-01-preview" + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.AppConfiguration/configurationStores", + "properties": { + "provisioningState": "Succeeded", + "creationDate": "2018-04-24T16:30:55+00:00", + "endpoint": "https://fayeh.azconfig.io" + }, + "id": "/subscriptions/c80fb759-c965-4c6a-9110-9b2b2d038882/resourceGroups/myResourceGroup/providers/Microsoft.AppConfiguration/configurationStores/fayeh", + "name": "fayeh", + "location": "westus", + "tags": {} + } + } + } +} \ No newline at end of file diff --git a/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/preview/2019-02-01-preview/examples/ConfigurationStoresList.json b/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/preview/2019-02-01-preview/examples/ConfigurationStoresList.json new file mode 100644 index 000000000000..eb6e12c09fb2 --- /dev/null +++ b/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/preview/2019-02-01-preview/examples/ConfigurationStoresList.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "subscriptionId": "c80fb759-c965-4c6a-9110-9b2b2d038882", + "api-version": "2019-02-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [{ + "type": "Microsoft.AppConfiguration/configurationStores", + "properties": { + "provisioningState": "Succeeded", + "creationDate": "2018-04-24T16:30:55+00:00", + "endpoint": "https://fayeh.azconfig.io" + }, + "id": "/subscriptions/c80fb759-c965-4c6a-9110-9b2b2d038882/resourceGroups/myResourceGroup/providers/Microsoft.AppConfiguration/configurationStores/fayeh", + "name": "fayeh", + "location": "westus", + "tags": {} + }, + { + "type": "Microsoft.AppConfiguration/configurationStores", + "properties": { + "provisioningState": "Succeeded", + "creationDate": "2018-04-24T23:06:59+00:00", + "endpoint": "https://fayeh2.azconfig.io" + }, + "id": "/subscriptions/c80fb759-c965-4c6a-9110-9b2b2d038882/resourceGroups/myResourceGroup/providers/Microsoft.AppConfiguration/configurationStores/fayeh2", + "name": "fayeh2", + "location": "westus", + "tags": {} + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/preview/2019-02-01-preview/examples/ConfigurationStoresListByResourceGroup.json b/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/preview/2019-02-01-preview/examples/ConfigurationStoresListByResourceGroup.json new file mode 100644 index 000000000000..08e7cc550096 --- /dev/null +++ b/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/preview/2019-02-01-preview/examples/ConfigurationStoresListByResourceGroup.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "subscriptionId": "c80fb759-c965-4c6a-9110-9b2b2d038882", + "resourceGroupName": "myResourceGroup", + "api-version": "2019-02-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [{ + "type": "Microsoft.AppConfiguration/configurationStores", + "properties": { + "provisioningState": "Succeeded", + "creationDate": "2018-04-24T16:30:55+00:00", + "endpoint": "https://fayeh.azconfig.io" + }, + "id": "/subscriptions/c80fb759-c965-4c6a-9110-9b2b2d038882/resourceGroups/myResourceGroup/providers/Microsoft.AppConfiguration/configurationStores/fayeh", + "name": "fayeh", + "location": "westus", + "tags": {} + }, + { + "type": "Microsoft.AppConfiguration/configurationStores", + "properties": { + "provisioningState": "Succeeded", + "creationDate": "2018-04-24T23:06:59+00:00", + "endpoint": "https://fayeh2.azconfig.io" + }, + "id": "/subscriptions/c80fb759-c965-4c6a-9110-9b2b2d038882/resourceGroups/myResourceGroup/providers/Microsoft.AppConfiguration/configurationStores/fayeh2", + "name": "fayeh2", + "location": "westus", + "tags": {} + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/preview/2019-02-01-preview/examples/ConfigurationStoresListKeys.json b/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/preview/2019-02-01-preview/examples/ConfigurationStoresListKeys.json new file mode 100644 index 000000000000..0151be3a7f56 --- /dev/null +++ b/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/preview/2019-02-01-preview/examples/ConfigurationStoresListKeys.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "subscriptionId": "c80fb759-c965-4c6a-9110-9b2b2d038882", + "resourceGroupName": "myResourceGroup", + "configStoreName": "fayeh", + "api-version": "2019-02-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "439AD01B4BE67DB1", + "name": "Primary", + "value": "000000000000000000000000000000000000000000000000000000", + "connectionString": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", + "lastModified": "2018-04-24T16:30:54+00:00", + "readOnly": false + }, + { + "id": "CB45E100456857B9", + "name": "Secondary", + "value": "000000000000000000000000000000000000000000000000000000", + "connectionString": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", + "lastModified": "2018-04-24T16:30:54+00:00", + "readOnly": false + }, + { + "id": "B3AC55B7E71431A9", + "name": "Primary Read Only", + "value": "000000000000000000000000000000000000000000000000000000", + "connectionString": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", + "lastModified": "2018-04-24T16:30:54+00:00", + "readOnly": true + }, + { + "id": "E2AF6A9A89DCC177", + "name": "Secondary Read Only", + "value": "000000000000000000000000000000000000000000000000000000", + "connectionString": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", + "lastModified": "2018-04-24T16:30:54+00:00", + "readOnly": true + } + ] + } + } + } +} diff --git a/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/preview/2019-02-01-preview/examples/ConfigurationStoresRegenerateKey.json b/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/preview/2019-02-01-preview/examples/ConfigurationStoresRegenerateKey.json new file mode 100644 index 000000000000..6b191acd5a2a --- /dev/null +++ b/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/preview/2019-02-01-preview/examples/ConfigurationStoresRegenerateKey.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "subscriptionId": "c80fb759-c965-4c6a-9110-9b2b2d038882", + "resourceGroupName": "myResourceGroup", + "configStoreName": "fayeh", + "api-version": "2019-02-01-preview", + "regenerateKeyParameters": { + "id": "439AD01B4BE67DB1" + } + }, + "responses": { + "200": { + "body": { + "id": "439AD01B4BE67DB1", + "name": "Primary", + "value": "000000000000000000000000000000000000000000000000000000", + "connectionString": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", + "lastModified": "2018-04-26T22:59:24.2370906+00:00", + "readOnly": false + } + } + } +} diff --git a/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/preview/2019-02-01-preview/examples/ConfigurationStoresUpdate.json b/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/preview/2019-02-01-preview/examples/ConfigurationStoresUpdate.json new file mode 100644 index 000000000000..0525a89781e4 --- /dev/null +++ b/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/preview/2019-02-01-preview/examples/ConfigurationStoresUpdate.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "c80fb759-c965-4c6a-9110-9b2b2d038882", + "resourceGroupName": "myResourceGroup", + "configStoreName": "fayeh", + "api-version": "2019-02-01-preview", + "configStoreUpdateParameters": { + "tags": { + "Category": "Marketing" + } + } + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.AppConfiguration/configurationStores", + "properties": { + "provisioningState": "Succeeded", + "creationDate": "2018-04-24T16:30:55+00:00", + "endpoint": "https://fayeh.azconfig.io" + }, + "id": "/subscriptions/c80fb759-c965-4c6a-9110-9b2b2d038882/resourceGroups/myResourceGroup/providers/Microsoft.AppConfiguration/configurationStores/fayeh", + "name": "fayeh", + "location": "westus", + "tags": { + "Category": "Marketing" + } + } + }, + "201": { + "body": { + "type": "Microsoft.AppConfiguration/configurationStores", + "properties": { + "provisioningState": "Updating", + "creationDate": "2018-04-24T16:30:55+00:00", + "endpoint": "https://fayeh.azconfig.io" + }, + "id": "/subscriptions/c80fb759-c965-4c6a-9110-9b2b2d038882/resourceGroups/myResourceGroup/providers/Microsoft.AppConfiguration/configurationStores/fayeh", + "name": "fayeh", + "location": "westus", + "tags": { + "Category": "Marketing" + } + } + } + } +} \ No newline at end of file diff --git a/specification/appconfiguration/resource-manager/readme.csharp.md b/specification/appconfiguration/resource-manager/readme.csharp.md new file mode 100644 index 000000000000..36356e9f631e --- /dev/null +++ b/specification/appconfiguration/resource-manager/readme.csharp.md @@ -0,0 +1,14 @@ +## 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 + namespace: Microsoft.Azure.Management.AppConfiguration + payload-flattening-threshold: 2 + output-folder: $(csharp-sdks-folder)/AppConfiguration/Management.AppConfiguration/Generated + clear-output-folder: true +``` diff --git a/specification/appconfiguration/resource-manager/readme.java.md b/specification/appconfiguration/resource-manager/readme.java.md new file mode 100644 index 000000000000..e8b2672558de --- /dev/null +++ b/specification/appconfiguration/resource-manager/readme.java.md @@ -0,0 +1,14 @@ +## Java + +These settings apply only when `--java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(java) +java: + azure-arm: true + fluent: true + namespace: com.microsoft.azure.management.appconfiguration + license-header: MICROSOFT_MIT_NO_CODEGEN + payload-flattening-threshold: 1 + output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-appconfiguration +``` diff --git a/specification/appconfiguration/resource-manager/readme.md b/specification/appconfiguration/resource-manager/readme.md new file mode 100644 index 000000000000..39faedc9455d --- /dev/null +++ b/specification/appconfiguration/resource-manager/readme.md @@ -0,0 +1,89 @@ +# AppConfiguration + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for AppConfiguration. + +--- + +## Getting Started + +To build the SDK for AppConfiguration, 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 AppConfiguration API. + +``` yaml +openapi-type: arm +tag: package-2019-02-01-preview +``` + +### Tag: package-2019-02-01-preview + +These settings apply only when `--tag=package-2019-02-01-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2019-02-01-preview' +input-file: +- Microsoft.AppConfiguration/preview/2019-02-01-preview/appconfiguration.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-python + - repo: azure-sdk-for-java + - repo: azure-sdk-for-net + - repo: azure-sdk-for-js + - repo: azure-sdk-for-ruby + after_scripts: + - bundle install && rake arm:regen_all_profiles['azure_mgmt_app_configuration'] +``` + +## C# + +See configuration in [readme.csharp.md](./readme.csharp.md) + +## Python + +See configuration in [readme.python.md](./readme.python.md) + +## Java + +See configuration in [readme.java.md](./readme.java.md) + +## Ruby + +See configuration in [readme.ruby.md](./readme.ruby.md) + +## Suppression + +``` yaml +directive: + - suppress: EnumInsteadOfBoolean + from: appconfiguration.json + where: $.definitions.NameAvailabilityStatus.properties.nameAvailable + reason: This is standard for check name availability. + - suppress: EnumInsteadOfBoolean + from: appconfiguration.json + where: $.definitions.ApiKey.properties.readOnly + reason: We did consider using an enum instead but found it to not be helpful. +``` diff --git a/specification/appconfiguration/resource-manager/readme.python.md b/specification/appconfiguration/resource-manager/readme.python.md new file mode 100644 index 000000000000..e1c7b10da6b2 --- /dev/null +++ b/specification/appconfiguration/resource-manager/readme.python.md @@ -0,0 +1,27 @@ +## Python + +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) +python-mode: create +python: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + payload-flattening-threshold: 2 + namespace: azure.mgmt.appconfiguration + package-name: azure-mgmt-appconfiguration + package-version: 2.0.0 + clear-output-folder: true +``` +``` yaml $(python) && $(python-mode) == 'update' +python: + no-namespace-folders: true + output-folder: $(python-sdks-folder)/azure-mgmt-appconfiguration/azure/mgmt/appconfiguration +``` +``` yaml $(python) && $(python-mode) == 'create' +python: + basic-setup-py: true + output-folder: $(python-sdks-folder)/azure-mgmt-appconfiguration +``` diff --git a/specification/appconfiguration/resource-manager/readme.ruby.md b/specification/appconfiguration/resource-manager/readme.ruby.md new file mode 100644 index 000000000000..0891f85eb858 --- /dev/null +++ b/specification/appconfiguration/resource-manager/readme.ruby.md @@ -0,0 +1,26 @@ +## Ruby + +These settings apply only when --ruby is specified on the command line. + +``` yaml +package-name: azure_mgmt_app_configuration +package-version: "0.16.0" +azure-arm: true +``` + +### Ruby multi-api + +``` yaml $(ruby) && $(multiapi) +batch: + - tag: package-2019-02-01-preview +``` + +### Tag: package-2019-02-01-preview and ruby + +These settings apply only when `--tag=package-2019-02-01-preview --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2019-02-01-preview' && $(ruby) +namespace: "Azure::AppConfiguration::Mgmt::V2019_02_01_preview" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_app_configuration/lib +``` diff --git a/specification/authorization/resource-manager/readme.csharp.md b/specification/authorization/resource-manager/readme.csharp.md index 1fdc24927763..dc6684e48ca7 100644 --- a/specification/authorization/resource-manager/readme.csharp.md +++ b/specification/authorization/resource-manager/readme.csharp.md @@ -15,6 +15,43 @@ csharp: clear-output-folder: true ``` +### Tag: package-locks-2016-09 + +These settings apply only when `--tag=package-locks-2016-09` is specified on the command line. + +``` yaml $(tag) == 'package-locks-2016-09' +input-file: +- ../../resources/resource-manager/Microsoft.Authorization/stable/2016-09-01/locks.json +``` + +### Tag: package-locks-2015-01 + +These settings apply only when `--tag=package-locks-2015-01` is specified on the command line. + +``` yaml $(tag) == 'package-locks-2015-01' +input-file: +- ../../resources/resource-manager/Microsoft.Authorization/stable/2015-01-01/locks.json +``` + +### Tag: package-policy-2016-12 + +These settings apply only when `--tag=package-policy-2016-12` is specified on the command line. + +``` yaml $(tag) == 'package-policy-2016-12' +input-file: +- ../../resources/resource-manager/Microsoft.Authorization/stable/2016-12-01/policyAssignments.json +- ../../resources/resource-manager/Microsoft.Authorization/stable/2016-12-01/policyDefinitions.json +``` + +### Tag: package-policy-2015-10-01-preview + +These settings apply only when `--tag=package-policy-2015-10-01-preview` is specified on the command line. + +``` yaml $(tag) == 'package-policy-2015-10-01-preview' +input-file: +- ../../resources/resource-manager/Microsoft.Authorization/preview/2015-10-01-preview/policy.json +``` + ``` yaml $(csharp) && !$(multiapi) && !$(profile) namespace: Microsoft.Azure.Management.Authorization output-folder: $(csharp-sdks-folder)/Authorization/Management.Authorization/Generated @@ -30,20 +67,33 @@ output-folder: $(csharp-sdks-folder)/$(profile)/Authorization/Management.Authori batch: - tag: package-2015-07 + - tag: package-locks-2015-01 ``` +### Profile: hybrid_2018_03_01 + +These settings apply only when `--profile=hybrid_2018_03_01` is specified on the command line. + ``` yaml $(profile)=='hybrid_2018_03_01' namespace: Microsoft.Azure.Management.Profiles.$(profile).Authorization output-folder: $(csharp-sdks-folder)/$(profile)/Authorization/Management.Authorization/Generated batch: - tag: package-2015-07 + - tag: package-locks-2016-09 + - tag: package-policy-2016-12 ``` +### Profile: profile_2017_03_09 + +These settings apply only when `--profile=profile_2017_03_09` is specified on the command line. + ``` yaml $(profile)=='profile_2017_03_09' namespace: Microsoft.Azure.Management.Profiles.$(profile).Authorization output-folder: $(csharp-sdks-folder)/$(profile)/Authorization/Management.Authorization/Generated batch: - tag: package-2015-07-authorization-only + - tag: package-locks-2015-01 + - tag: package-policy-2015-10-01-preview ``` \ No newline at end of file diff --git a/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/Location.json b/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/Location.json index b007c4d162a5..027c9431b297 100644 --- a/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/Location.json +++ b/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/Location.json @@ -114,37 +114,6 @@ } } } - }, - "delete": { - "x-ms-examples": { - "Deletes the specified location.": { - "$ref": "./examples/Location/Delete.json" - } - }, - "description": "Deletes the specified location.", - "tags": [ - "Locations" - ], - "operationId": "Locations_Delete", - "parameters": [ - { - "$ref": "Subscriptions.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "Subscriptions.json#/parameters/LocationParameter" - }, - { - "$ref": "Subscriptions.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK" - }, - "204": { - "description": "No Content" - } - } } } }, diff --git a/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/Offer.json b/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/Offer.json index 0855f57ed9d6..f031c3f226c5 100644 --- a/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/Offer.json +++ b/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/Offer.json @@ -198,7 +198,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Subscriptions.Admin/offers/{offer}/Metrics": { + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Subscriptions.Admin/offers/{offer}/metrics": { "get": { "x-ms-examples": { "Get the offer metrics.": { @@ -234,7 +234,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Subscriptions.Admin/offers/{offer}/MetricDefinitions": { + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Subscriptions.Admin/offers/{offer}/metricDefinitions": { "get": { "x-ms-examples": { "Get the metric definitions.": { diff --git a/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/Plan.json b/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/Plan.json index 3d23dfc2e231..0c6f3b11635f 100644 --- a/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/Plan.json +++ b/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/Plan.json @@ -198,7 +198,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Subscriptions.Admin/plans/{plan}/Metrics": { + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Subscriptions.Admin/plans/{plan}/metrics": { "get": { "x-ms-examples": { "Get the metrics of the specified plan.": { @@ -234,7 +234,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Subscriptions.Admin/plans/{plan}/MetricDefinitions": { + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Subscriptions.Admin/plans/{plan}/metricDefinitions": { "get": { "x-ms-examples": { "Get the metric definitions of the specified plan.": { diff --git a/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/Location/Delete.json b/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/Location/Delete.json deleted file mode 100644 index 61746f79ff99..000000000000 --- a/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/Location/Delete.json +++ /dev/null @@ -1,13 +0,0 @@ -{ - "parameters": { - "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", - "location": "local", - "api-version": "2015-11-01" - }, - "responses": { - "200": { - }, - "204":{ - } - } -} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/Ocr.json b/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/Ocr.json index 83f602b55430..f66829c2716e 100644 --- a/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/Ocr.json +++ b/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/Ocr.json @@ -52,7 +52,7 @@ ], "responses": { "202": { - "description": "The service has accepted the request and will start processing later. It will return Accepted immediately and include an Operation-Location header. Client side should further query the operation status using the URL specified in this header. The operation ID will expire in 48 hours.", + "description": "The service has accepted the request and will start processing later. It will return Accepted immediately and include an 'Operation-Location' header. Client side should further query the operation status using the URL specified in this header. The operation ID will expire in 48 hours.", "headers": { "Operation-Location": { "description": "URL to query for status of the operation. The operation ID will expire in 48 hours. ", @@ -68,7 +68,7 @@ } }, "x-ms-examples": { - "Successful Domain Model analysis request": { + "Successful Recognize Text request": { "$ref": "./examples/SuccessfulRecognizeTextWithUrl.json" } } @@ -105,7 +105,7 @@ } }, "x-ms-examples": { - "Successful Domain Model analysis request": { + "Successful Get Text Operation Result request": { "$ref": "./examples/SuccessfulGetTextOperationResult.json" } } @@ -113,7 +113,7 @@ }, "/read/core/asyncBatchAnalyze": { "post": { - "description": "Use this interface to get the result of a Read operation, employing the state-of-the-art Optical Character Recognition (OCR) algorithms optimized for text-heavy documents. When you use the Read File interface, the response contains a field called \"Operation-Location\". The \"Operation-Location\" field contains the URL that you must use for your \"Read Operation Result\" operation to access OCR results.​", + "description": "Use this interface to get the result of a Read operation, employing the state-of-the-art Optical Character Recognition (OCR) algorithms optimized for text-heavy documents. When you use the Read File interface, the response contains a field called 'Operation-Location'. The 'Operation-Location' field contains the URL that you must use for your 'GetReadOperationResult' operation to access OCR results.​", "operationId": "BatchReadFile", "parameters": [ { @@ -147,7 +147,7 @@ } }, "x-ms-examples": { - "Successful Domain Model analysis request": { + "Successful Batch Read File request": { "$ref": "./examples/SuccessfulBatchReadFileWithUrl.json" } } @@ -155,13 +155,13 @@ }, "/read/operations/{operationId}": { "get": { - "description": "This interface is used for getting OCR results of Read operation. The URL to this interface should be retrieved from \"Operation-Location\" field returned from Batch Read File interface.", + "description": "This interface is used for getting OCR results of Read operation. The URL to this interface should be retrieved from 'Operation-Location' field returned from Batch Read File interface.", "operationId": "GetReadOperationResult", "parameters": [ { "name": "operationId", "in": "path", - "description": "Id of read operation returned in the response of the \"Batch Read File\" interface.", + "description": "Id of read operation returned in the response of the 'Batch Read File' interface.", "required": true, "type": "string" } @@ -184,8 +184,8 @@ } }, "x-ms-examples": { - "Successful Domain Model analysis request": { - "$ref": "./examples/SuccessfulReadOperationResult.json" + "Successful Get Read Operation Result request": { + "$ref": "./examples/SuccessfulGetReadOperationResult.json" } } } @@ -228,7 +228,7 @@ } }, "x-ms-examples": { - "Successful Domain Model analysis request": { + "Successful Recognize Text request": { "$ref": "./examples/SuccessfulRecognizeTextWithStream.json" } } @@ -236,7 +236,7 @@ }, "/read/core/asyncBatchAnalyze?overload=stream": { "post": { - "description": "Use this interface to get the result of a Read Document operation, employing the state-of-the-art Optical Character Recognition (OCR) algorithms optimized for text-heavy documents. When you use the Read Document interface, the response contains a field called \"Operation-Location\". The \"Operation-Location\" field contains the URL that you must use for your \"Get Read Result operation\" to access OCR results.​", + "description": "Use this interface to get the result of a Read Document operation, employing the state-of-the-art Optical Character Recognition (OCR) algorithms optimized for text-heavy documents. When you use the Read Document interface, the response contains a field called 'Operation-Location'. The 'Operation-Location' field contains the URL that you must use for your 'Get Read Result operation' to access OCR results.​", "operationId": "BatchReadFileInStream", "parameters": [ { @@ -270,7 +270,7 @@ } }, "x-ms-examples": { - "Successful Domain Model analysis request": { + "Successful Batch Read File request": { "$ref": "./examples/SuccessfulBatchReadFileWithStream.json" } } @@ -301,7 +301,7 @@ "$ref": "#/definitions/OperationStatus" }, "recognitionResults": { - "description": "A array of text recognition result of the read operation.", + "description": "An array of text recognition result of the read operation.", "type": "array", "items": { "$ref": "#/definitions/TextRecognitionResult" @@ -325,7 +325,7 @@ "x-nullable": false }, "TextRecognitionResult": { - "description": "Json object representing a recognized text region", + "description": "An object representing a recognized text region", "type": "object", "required": [ "lines" @@ -348,7 +348,7 @@ "type": "number" }, "unit": { - "description": "The unit used in the Width, Height and BoundingBox. For images, the unit is \"pixel\". For PDF, the unit is \"inch\".", + "description": "The unit used in the Width, Height and BoundingBox. For images, the unit is 'pixel'. For PDF, the unit is 'inch'.", "type": "string", "enum": [ "pixel", @@ -370,7 +370,7 @@ } }, "Line": { - "description": "Json object representing a recognized text line.", + "description": "An object representing a recognized text line.", "type": "object", "properties": { "boundingBox": { @@ -391,7 +391,7 @@ } }, "Word": { - "description": "Json object representing a recognized word.", + "description": "An object representing a recognized word.", "type": "object", "required": [ "boundingBox", diff --git a/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulBatchReadFileWithStream.json b/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulBatchReadFileWithStream.json index 1cc9911c0d5d..1c521091bce6 100644 --- a/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulBatchReadFileWithStream.json +++ b/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulBatchReadFileWithStream.json @@ -8,7 +8,7 @@ "responses": { "202": { "header": { - "Operation-Location": "https://{domain}/vision/v2.0/getReadResult/e56ffa6e-1ee4-4042-bc07-993db706c95f" + "Operation-Location": "https://{domain}/vision/v2.0/read/operations/e56ffa6e-1ee4-4042-bc07-993db706c95f" } } } diff --git a/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulBatchReadFileWithUrl.json b/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulBatchReadFileWithUrl.json index a63e7ad443db..2b273fa7baeb 100644 --- a/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulBatchReadFileWithUrl.json +++ b/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulBatchReadFileWithUrl.json @@ -8,7 +8,7 @@ "responses": { "202": { "header": { - "Operation-Location": "https://{domain}/vision/v2.0/getReadResult/e56ffa6e-1ee4-4042-bc07-993db706c95f" + "Operation-Location": "https://{domain}/vision/v2.0/read/operations/e56ffa6e-1ee4-4042-bc07-993db706c95f" } } } diff --git a/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulReadOperationResult.json b/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulGetReadOperationResult.json similarity index 100% rename from specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulReadOperationResult.json rename to specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulGetReadOperationResult.json diff --git a/specification/cognitiveservices/data-plane/Face/stable/v1.0/Face.json b/specification/cognitiveservices/data-plane/Face/stable/v1.0/Face.json index 5ccdf42ae6d6..2d38a48797ac 100644 --- a/specification/cognitiveservices/data-plane/Face/stable/v1.0/Face.json +++ b/specification/cognitiveservices/data-plane/Face/stable/v1.0/Face.json @@ -294,7 +294,7 @@ }, "/persongroups/{personGroupId}/persons/{personId}": { "delete": { - "description": "Delete an existing person from a person group. All stored person data, and face features in the person entry will be deleted.", + "description": "Delete an existing person from a person group. The persistedFaceId, userData, person name and face feature in the person entry will all be deleted.", "operationId": "PersonGroupPerson_Delete", "parameters": [ { @@ -399,7 +399,7 @@ }, "/persongroups/{personGroupId}/persons/{personId}/persistedfaces/{persistedFaceId}": { "delete": { - "description": "Delete a face from a person. Relative feature for the persisted face will also be deleted.", + "description": "Delete a face from a person in a person group by specified personGroupId, personId and persistedFaceId.\n
Adding/deleting faces to/from a same person will be processed sequentially. Adding/deleting faces to/from different persons are processed in parallel.", "operationId": "PersonGroupPerson_DeleteFace", "parameters": [ { @@ -467,7 +467,7 @@ } }, "patch": { - "description": "Update a person persisted face's userData field.", + "description": "Add a face to a person into a person group for face identification or verification. To deal with an image contains multiple faces, input face can be specified as an image with a targetFace rectangle. It returns a persistedFaceId representing the added face. No image will be stored. Only the extracted face feature will be stored on server until [PersonGroup PersonFace - Delete](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f3039523e), [PersonGroup Person - Delete](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f3039523d) or [PersonGroup - Delete](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395245) is called.\n
Note persistedFaceId is different from faceId generated by [Face - Detect](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395236).\n* Higher face image quality means better recognition precision. Please consider high-quality faces: frontal, clear, and face size is 200x200 pixels (100 pixels between eyes) or bigger.\n* Each person entry can hold up to 248 faces.\n* JPEG, PNG, GIF (the first frame), and BMP format are supported. The allowed image file size is from 1KB to 6MB.\n* \"targetFace\" rectangle should contain one face. Zero or multiple faces will be regarded as an error. If the provided \"targetFace\" rectangle is not returned from [Face - Detect](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395236), there’s no guarantee to detect and add the face successfully.\n* Out of detectable face size (36x36 - 4096x4096 pixels), large head-pose, or large occlusions will cause failures.\n* Adding/deleting faces to/from a same person will be processed sequentially. Adding/deleting faces to/from different persons are processed in parallel.", "operationId": "PersonGroupPerson_UpdateFace", "parameters": [ { @@ -513,7 +513,7 @@ }, "/persongroups/{personGroupId}": { "put": { - "description": "Create a new person group with specified personGroupId, name, user-provided userData and recognitionModel.\n
A person group is the container of the uploaded person data, including face images and face recognition features.\n
After creation, use [PersonGroup Person - Create](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f3039523c) to add persons into the group, and then call [PersonGroup - Train](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395249) to get this group ready for [Face - Identify](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395239).\n
The person's face, image, and userData will be stored on server until [PersonGroup Person - Delete](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f3039523d) or [PersonGroup - Delete](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395245) is called.\n
\n* Free-tier subscription quota: 1,000 person groups. Each holds up to 1,000 persons.\n* S0-tier subscription quota: 1,000,000 person groups. Each holds up to 10,000 persons.\n* to handle larger scale face identification problem, please consider using [LargePersonGroup](/docs/services/563879b61984550e40cbbe8d/operations/599acdee6ac60f11b48b5a9d).\n
\n'recognitionModel' should be specified to associate with this person group. The default value for 'recognitionModel' is 'recognition_01', if the latest model needed, please explicitly specify the model you need in this parameter. New faces that are added to an existing person group will use the recognition model that's already associated with the collection. Existing face features in a person group can't be updated to features extracted by another version of recognition model.\n", + "description": "Create a new person group with specified personGroupId, name, user-provided userData and recognitionModel.\n
A person group is the container of the uploaded person data, including face recognition features.\n
After creation, use [PersonGroup Person - Create](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f3039523c) to add persons into the group, and then call [PersonGroup - Train](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395249) to get this group ready for [Face - Identify](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395239).\n
No image will be stored. Only the person's extracted face features and userData will be stored on server until [PersonGroup Person - Delete](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f3039523d) or [PersonGroup - Delete](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395245) is called.\n
'recognitionModel' should be specified to associate with this person group. The default value for 'recognitionModel' is 'recognition_01', if the latest model needed, please explicitly specify the model you need in this parameter. New faces that are added to an existing person group will use the recognition model that's already associated with the collection. Existing face features in a person group can't be updated to features extracted by another version of recognition model.\n* 'recognition_01': The default recognition model for [PersonGroup - Create](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395244). All those person groups created before 2019 March are bonded with this recognition model.\n* 'recognition_02': Recognition model released in 2019 March. 'recognition_02' is recommended since its overall accuracy is improved compared with 'recognition_01'.\n\nPerson group quota:\n* Free-tier subscription quota: 1,000 person groups. Each holds up to 1,000 persons.\n* S0-tier subscription quota: 1,000,000 person groups. Each holds up to 10,000 persons.\n* to handle larger scale face identification problem, please consider using [LargePersonGroup](/docs/services/563879b61984550e40cbbe8d/operations/599acdee6ac60f11b48b5a9d).", "operationId": "PersonGroup_Create", "parameters": [ { @@ -764,7 +764,7 @@ }, "/facelists/{faceListId}": { "put": { - "description": "Create an empty face list with user-specified faceListId, name, an optional userData and recognitionModel. Up to 64 face lists are allowed in one subscription.\n
Face list is a list of faces, up to 1,000 faces, and used by [Face - Find Similar](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395237).\n
After creation, user should use [FaceList - Add Face](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395250) to import the faces. Faces are stored on server until [FaceList - Delete](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f3039524f) is called.\n
Find Similar is used for scenario like finding celebrity-like faces, similar face filtering, or as a light way face identification. But if the actual use is to identify person, please use [PersonGroup](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395244) / [LargePersonGroup](/docs/services/563879b61984550e40cbbe8d/operations/599acdee6ac60f11b48b5a9d) and [Face - Identify](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395239).\n
Please consider [LargeFaceList](/docs/services/563879b61984550e40cbbe8d/operations/5a157b68d2de3616c086f2cc) when the face number is large. It can support up to 1,000,000 faces. 'recognitionModel' should be specified to associate with this face list. The default value for 'recognitionModel' is 'recognition_01', if the latest model needed, please explicitly specify the model you need in this parameter. New faces that are added to an existing face list will use the recognition model that's already associated with the collection. Existing face features in a face list can't be updated to features extracted by another version of recognition model.\n", + "description": "Create an empty face list with user-specified faceListId, name, an optional userData and recognitionModel. Up to 64 face lists are allowed in one subscription.\n
Face list is a list of faces, up to 1,000 faces, and used by [Face - Find Similar](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395237).\n
After creation, user should use [FaceList - Add Face](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395250) to import the faces. No image will be stored. Only the extracted face features are stored on server until [FaceList - Delete](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f3039524f) is called.\n
Find Similar is used for scenario like finding celebrity-like faces, similar face filtering, or as a light way face identification. But if the actual use is to identify person, please use [PersonGroup](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395244) / [LargePersonGroup](/docs/services/563879b61984550e40cbbe8d/operations/599acdee6ac60f11b48b5a9d) and [Face - Identify](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395239).\n
Please consider [LargeFaceList](/docs/services/563879b61984550e40cbbe8d/operations/5a157b68d2de3616c086f2cc) when the face number is large. It can support up to 1,000,000 faces.\n
'recognitionModel' should be specified to associate with this face list. The default value for 'recognitionModel' is 'recognition_01', if the latest model needed, please explicitly specify the model you need in this parameter. New faces that are added to an existing face list will use the recognition model that's already associated with the collection. Existing face features in a face list can't be updated to features extracted by another version of recognition model.\n* 'recognition_01': The default recognition model for [FaceList- Create](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f3039524b). All those face lists created before 2019 March are bonded with this recognition model.\n* 'recognition_02': Recognition model released in 2019 March. 'recognition_02' is recommended since its overall accuracy is improved compared with 'recognition_01'.", "operationId": "FaceList_Create", "parameters": [ { @@ -877,7 +877,7 @@ } }, "delete": { - "description": "Delete an existing face list according to faceListId. Persisted face images in the face list will also be deleted.", + "description": "Delete a specified face list.", "operationId": "FaceList_Delete", "parameters": [ { @@ -910,7 +910,7 @@ { "$ref": "#/parameters/returnRecognitionModel" } - ], + ], "responses": { "200": { "description": "A successful call returns an array of faceList.", @@ -937,7 +937,7 @@ }, "/facelists/{faceListId}/persistedfaces/{persistedFaceId}": { "delete": { - "description": "Delete an existing face from a face list (given by a persistedFaceId and a faceListId). Persisted image related to the face will also be deleted.", + "description": "Delete a face from a face list by specified faceListId and persistedFaceId.\n
Adding/deleting faces to/from a same face list are processed sequentially and to/from different face lists are in parallel.", "operationId": "FaceList_DeleteFace", "parameters": [ { @@ -967,7 +967,7 @@ }, "/persongroups/{personGroupId}/persons/{personId}/persistedfaces": { "post": { - "description": "Add a representative face to a person for identification. The input face is specified as an image with a targetFace rectangle.", + "description": "Add a face to a person into a large person group for face identification or verification. To deal with an image contains multiple faces, input face can be specified as an image with a targetFace rectangle. It returns a persistedFaceId representing the added face. No image will be stored. Only the extracted face feature will be stored on server until [LargePersonGroup PersonFace - Delete](/docs/services/563879b61984550e40cbbe8d/operations/599ae2966ac60f11b48b5aa3), [LargePersonGroup Person - Delete](/docs/services/563879b61984550e40cbbe8d/operations/599ade5c6ac60f11b48b5aa2) or [LargePersonGroup - Delete](/docs/services/563879b61984550e40cbbe8d/operations/599adc216ac60f11b48b5a9f) is called.\n
Note persistedFaceId is different from faceId generated by [Face - Detect](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395236).\n* Higher face image quality means better recognition precision. Please consider high-quality faces: frontal, clear, and face size is 200x200 pixels (100 pixels between eyes) or bigger.\n* Each person entry can hold up to 248 faces.\n* JPEG, PNG, GIF (the first frame), and BMP format are supported. The allowed image file size is from 1KB to 6MB.\n* \"targetFace\" rectangle should contain one face. Zero or multiple faces will be regarded as an error. If the provided \"targetFace\" rectangle is not returned from [Face - Detect](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395236), there’s no guarantee to detect and add the face successfully.\n* Out of detectable face size (36x36 - 4096x4096 pixels), large head-pose, or large occlusions will cause failures.\n* Adding/deleting faces to/from a same person will be processed sequentially. Adding/deleting faces to/from different persons are processed in parallel.", "operationId": "PersonGroupPerson_AddFaceFromUrl", "parameters": [ { @@ -1015,7 +1015,7 @@ }, "/detect": { "post": { - "description": "Detect human faces in an image, return face rectangles, and optionally with faceIds, landmarks, and attributes.
\n* Optional parameters including faceId, landmarks, and attributes. Attributes include age, gender, headPose, smile, facialHair, glasses, emotion, hair, makeup, occlusion, accessories, blur, exposure and noise.\n* The extracted face feature, instead of the actual image, will be stored on server. The faceId is an identifier of the face feature and will be used in [Face - Identify](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395239), [Face - Verify](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f3039523a), and [Face - Find Similar](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395237). It will expire 24 hours after the detection call.\n* Higher face image quality means better detection and recognition precision. Please consider high-quality faces: frontal, clear, and face size is 200x200 pixels (100 pixels between eyes) or bigger.\n* JPEG, PNG, GIF (the first frame), and BMP format are supported. The allowed image file size is from 1KB to 6MB.\n* Faces are detectable when its size is 36x36 to 4096x4096 pixels. If need to detect very small but clear faces, please try to enlarge the input image.\n* Up to 64 faces can be returned for an image. Faces are ranked by face rectangle size from large to small.\n* Face detector prefer frontal and near-frontal faces. There are cases that faces may not be detected, e.g. exceptionally large face angles (head-pose) or being occluded, or wrong image orientation.\n* Attributes (age, gender, headPose, smile, facialHair, glasses, emotion, hair, makeup, occlusion, accessories, blur, exposure and noise) may not be perfectly accurate. HeadPose's pitch value is a reserved field and will always return 0.\n* Different 'recognitionModel' values are provided. If follow-up operations like Verify, Identify, Find Similar are needed, please specify the recognition model with 'recognitionModel' parameter. The default value for 'recognitionModel' is 'recognition_01', if latest model needed, please explicitly specify the model you need in this parameter. Once specified, the detected faceIds will be associated with the specified recognition model. More details, please refer to [How to specify a recognition model](https://docs.microsoft.com/en-us/azure/cognitive-services/face/face-api-how-to-topics/specify-recognition-model)\n", + "description": "Detect human faces in an image, return face rectangles, and optionally with faceIds, landmarks, and attributes.
\n* Optional parameters including faceId, landmarks, and attributes. Attributes include age, gender, headPose, smile, facialHair, glasses, emotion, hair, makeup, occlusion, accessories, blur, exposure and noise.\n* No image will be stored. Only the extracted face feature will be stored on server. The faceId is an identifier of the face feature and will be used in [Face - Identify](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395239), [Face - Verify](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f3039523a), and [Face - Find Similar](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395237). It will expire 24 hours after the detection call.\n* Higher face image quality means better detection and recognition precision. Please consider high-quality faces: frontal, clear, and face size is 200x200 pixels (100 pixels between eyes) or bigger.\n* JPEG, PNG, GIF (the first frame), and BMP format are supported. The allowed image file size is from 1KB to 6MB.\n* Faces are detectable when its size is 36x36 to 4096x4096 pixels. If need to detect very small but clear faces, please try to enlarge the input image.\n* Up to 64 faces can be returned for an image. Faces are ranked by face rectangle size from large to small.\n* Face detector prefer frontal and near-frontal faces. There are cases that faces may not be detected, e.g. exceptionally large face angles (head-pose) or being occluded, or wrong image orientation.\n* Attributes (age, gender, headPose, smile, facialHair, glasses, emotion, hair, makeup, occlusion, accessories, blur, exposure and noise) may not be perfectly accurate.\n* Different 'recognitionModel' values are provided. If follow-up operations like Verify, Identify, Find Similar are needed, please specify the recognition model with 'recognitionModel' parameter. The default value for 'recognitionModel' is 'recognition_01', if latest model needed, please explicitly specify the model you need in this parameter. Once specified, the detected faceIds will be associated with the specified recognition model. More details, please refer to [How to specify a recognition model](https://docs.microsoft.com/en-us/azure/cognitive-services/face/face-api-how-to-topics/specify-recognition-model)", "operationId": "Face_DetectWithUrl", "parameters": [ { @@ -1074,7 +1074,7 @@ }, "/facelists/{faceListId}/persistedfaces": { "post": { - "description": "Add a face to a face list. The input face is specified as an image with a targetFace rectangle. It returns a persistedFaceId representing the added face, and persistedFaceId will not expire.", + "description": "Add a face to a specified face list, up to 1,000 faces.\n
To deal with an image contains multiple faces, input face can be specified as an image with a targetFace rectangle. It returns a persistedFaceId representing the added face. No image will be stored. Only the extracted face feature will be stored on server until [FaceList - Delete Face](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395251) or [FaceList - Delete](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f3039524f) is called.\n
Note persistedFaceId is different from faceId generated by [Face - Detect](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395236).\n* Higher face image quality means better detection and recognition precision. Please consider high-quality faces: frontal, clear, and face size is 200x200 pixels (100 pixels between eyes) or bigger.\n* JPEG, PNG, GIF (the first frame), and BMP format are supported. The allowed image file size is from 1KB to 6MB.\n* \"targetFace\" rectangle should contain one face. Zero or multiple faces will be regarded as an error. If the provided \"targetFace\" rectangle is not returned from [Face - Detect](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395236), there’s no guarantee to detect and add the face successfully.\n* Out of detectable face size (36x36 - 4096x4096 pixels), large head-pose, or large occlusions will cause failures.\n* Adding/deleting faces to/from a same face list are processed sequentially and to/from different face lists are in parallel.", "operationId": "FaceList_AddFaceFromUrl", "parameters": [ { @@ -1212,7 +1212,7 @@ }, "/largepersongroups/{largePersonGroupId}/persons/{personId}": { "delete": { - "description": "Delete an existing person from a large person group. All stored person data, and face features in the person entry will be deleted.", + "description": "Delete an existing person from a large person group. The persistedFaceId, userData, person name and face feature in the person entry will all be deleted.", "operationId": "LargePersonGroupPerson_Delete", "parameters": [ { @@ -1240,7 +1240,7 @@ } }, "get": { - "description": "Retrieve a person's information, including registered persisted faces, name and userData.", + "description": "Retrieve a person's name and userData, and the persisted faceIds representing the registered person face feature.", "operationId": "LargePersonGroupPerson_Get", "parameters": [ { @@ -1317,7 +1317,7 @@ }, "/largepersongroups/{largePersonGroupId}/persons/{personId}/persistedfaces/{persistedFaceId}": { "delete": { - "description": "Delete a face from a person. Relative feature for the persisted face will also be deleted.", + "description": "Delete a face from a person in a large person group by specified largePersonGroupId, personId and persistedFaceId.\n
Adding/deleting faces to/from a same person will be processed sequentially. Adding/deleting faces to/from different persons are processed in parallel.", "operationId": "LargePersonGroupPerson_DeleteFace", "parameters": [ { @@ -1431,7 +1431,7 @@ }, "/largepersongroups/{largePersonGroupId}": { "put": { - "description": "Create a new large person group with user-specified largePersonGroupId, name, an optional userData and recognitionModel.\n
A large person group is the container of the uploaded person data, including face images and face recognition feature, and up to 1,000,000 people.\n
After creation, use [LargePersonGroup Person - Create](/docs/services/563879b61984550e40cbbe8d/operations/599adcba3a7b9412a4d53f40) to add person into the group, and call [LargePersonGroup - Train](/docs/services/563879b61984550e40cbbe8d/operations/599ae2d16ac60f11b48b5aa4) to get this group ready for [Face - Identify](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395239).\n
The person face, image, and userData will be stored on server until [LargePersonGroup Person - Delete](/docs/services/563879b61984550e40cbbe8d/operations/599ade5c6ac60f11b48b5aa2) or [LargePersonGroup - Delete](/docs/services/563879b61984550e40cbbe8d/operations/599adc216ac60f11b48b5a9f) is called.\n
\n* Free-tier subscription quota: 1,000 large person groups.\n* S0-tier subscription quota: 1,000,000 large person groups.\n
\n'recognitionModel' should be specified to associate with this large person group. The default value for 'recognitionModel' is 'recognition_01', if the latest model needed, please explicitly specify the model you need in this parameter. New faces that are added to an existing large person group will use the recognition model that's already associated with the collection. Existing face features in a large person group can't be updated to features extracted by another version of recognition model.\n", + "description": "Create a new large person group with user-specified largePersonGroupId, name, an optional userData and recognitionModel.\n
A large person group is the container of the uploaded person data, including face recognition feature, and up to 1,000,000\npeople.\n
After creation, use [LargePersonGroup Person - Create](/docs/services/563879b61984550e40cbbe8d/operations/599adcba3a7b9412a4d53f40) to add person into the group, and call [LargePersonGroup - Train](/docs/services/563879b61984550e40cbbe8d/operations/599ae2d16ac60f11b48b5aa4) to get this group ready for [Face - Identify](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395239).\n
No image will be stored. Only the person's extracted face features and userData will be stored on server until [LargePersonGroup Person - Delete](/docs/services/563879b61984550e40cbbe8d/operations/599ade5c6ac60f11b48b5aa2) or [LargePersonGroup - Delete](/docs/services/563879b61984550e40cbbe8d/operations/599adc216ac60f11b48b5a9f) is called.\n
'recognitionModel' should be specified to associate with this large person group. The default value for 'recognitionModel' is 'recognition_01', if the latest model needed, please explicitly specify the model you need in this parameter. New faces that are added to an existing large person group will use the recognition model that's already associated with the collection. Existing face features in a large person group can't be updated to features extracted by another version of recognition model.\n* 'recognition_01': The default recognition model for [LargePersonGroup - Create](/docs/services/563879b61984550e40cbbe8d/operations/599acdee6ac60f11b48b5a9d). All those large person groups created before 2019 March are bonded with this recognition model.\n* 'recognition_02': Recognition model released in 2019 March. 'recognition_02' is recommended since its overall accuracy is improved compared with 'recognition_01'.\n\nLarge person group quota:\n* Free-tier subscription quota: 1,000 large person groups.\n* S0-tier subscription quota: 1,000,000 large person groups.", "operationId": "LargePersonGroup_Create", "parameters": [ { @@ -1682,7 +1682,7 @@ }, "/largepersongroups/{largePersonGroupId}/persons/{personId}/persistedfaces": { "post": { - "description": "Add a representative face to a person for identification. The input face is specified as an image with a targetFace rectangle.", + "description": "Add a face to a person into a large person group for face identification or verification. To deal with an image contains multiple faces, input face can be specified as an image with a targetFace rectangle. It returns a persistedFaceId representing the added face. No image will be stored. Only the extracted face feature will be stored on server until [LargePersonGroup PersonFace - Delete](/docs/services/563879b61984550e40cbbe8d/operations/599ae2966ac60f11b48b5aa3), [LargePersonGroup Person - Delete](/docs/services/563879b61984550e40cbbe8d/operations/599ade5c6ac60f11b48b5aa2) or [LargePersonGroup - Delete](/docs/services/563879b61984550e40cbbe8d/operations/599adc216ac60f11b48b5a9f) is called.\n
Note persistedFaceId is different from faceId generated by [Face - Detect](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395236).\n* Higher face image quality means better recognition precision. Please consider high-quality faces: frontal, clear, and face size is 200x200 pixels (100 pixels between eyes) or bigger.\n* Each person entry can hold up to 248 faces.\n* JPEG, PNG, GIF (the first frame), and BMP format are supported. The allowed image file size is from 1KB to 6MB.\n* \"targetFace\" rectangle should contain one face. Zero or multiple faces will be regarded as an error. If the provided \"targetFace\" rectangle is not returned from [Face - Detect](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395236), there’s no guarantee to detect and add the face successfully.\n* Out of detectable face size (36x36 - 4096x4096 pixels), large head-pose, or large occlusions will cause failures.\n* Adding/deleting faces to/from a same person will be processed sequentially. Adding/deleting faces to/from different persons are processed in parallel.", "operationId": "LargePersonGroupPerson_AddFaceFromUrl", "parameters": [ { @@ -1730,7 +1730,7 @@ }, "/largefacelists/{largeFaceListId}": { "put": { - "description": "Create an empty large face list with user-specified largeFaceListId, name, an optional userData and recognitionModel.\n
Large face list is a list of faces, up to 1,000,000 faces, and used by [Face - Find Similar](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395237).\n
After creation, user should use [LargeFaceList Face - Add](/docs/services/563879b61984550e40cbbe8d/operations/5a158c10d2de3616c086f2d3) to import the faces and [LargeFaceList - Train](/docs/services/563879b61984550e40cbbe8d/operations/5a158422d2de3616c086f2d1) to make it ready for [Face - FindSimilar](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395237). Faces are stored on server until [LargeFaceList - Delete](/docs/services/563879b61984550e40cbbe8d/operations/5a1580d5d2de3616c086f2cd) is called.\n
Find Similar is used for scenario like finding celebrity-like faces, similar face filtering, or as a light way face identification. But if the actual use is to identify person, please use [PersonGroup](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395244) / [LargePersonGroup](/docs/services/563879b61984550e40cbbe8d/operations/599acdee6ac60f11b48b5a9d) and [Face - Identify](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395239).\n
\n* Free-tier subscription quota: 64 large face lists.\n* S0-tier subscription quota: 1,000,000 large face lists.\n
\n'recognitionModel' should be specified to associate with this large face list. The default value for 'recognitionModel' is 'recognition_01', if the latest model needed, please explicitly specify the model you need in this parameter. New faces that are added to an existing large face list will use the recognition model that's already associated with the collection. Existing face features in a large face list can't be updated to features extracted by another version of recognition model.\n", + "description": "Create an empty large face list with user-specified largeFaceListId, name, an optional userData and recognitionModel.\n
Large face list is a list of faces, up to 1,000,000 faces, and used by [Face - Find Similar](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395237).\n
After creation, user should use [LargeFaceList Face - Add](/docs/services/563879b61984550e40cbbe8d/operations/5a158c10d2de3616c086f2d3) to import the faces and [LargeFaceList - Train](/docs/services/563879b61984550e40cbbe8d/operations/5a158422d2de3616c086f2d1) to make it ready for [Face - Find Similar](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395237). No image will be stored. Only the extracted face features are stored on server until [LargeFaceList - Delete](/docs/services/563879b61984550e40cbbe8d/operations/5a1580d5d2de3616c086f2cd) is called.\n
Find Similar is used for scenario like finding celebrity-like faces, similar face filtering, or as a light way face identification. But if the actual use is to identify person, please use [PersonGroup](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395244) / [LargePersonGroup](/docs/services/563879b61984550e40cbbe8d/operations/599acdee6ac60f11b48b5a9d) and [Face - Identify](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395239).\n
'recognitionModel' should be specified to associate with this large face list. The default value for 'recognitionModel' is 'recognition_01', if the latest model needed, please explicitly specify the model you need in this parameter. New faces that are added to an existing large face list will use the recognition model that's already associated with the collection. Existing face features in a large face list can't be updated to features extracted by another version of recognition model.\n* 'recognition_01': The default recognition model for [LargeFaceList- Create](/docs/services/563879b61984550e40cbbe8d/operations/5a157b68d2de3616c086f2cc). All those large face lists created before 2019 March are bonded with this recognition model.\n* 'recognition_02': Recognition model released in 2019 March. 'recognition_02' is recommended since its overall accuracy is improved compared with 'recognition_01'.\n\nLarge face list quota:\n* Free-tier subscription quota: 64 large face lists.\n* S0-tier subscription quota: 1,000,000 large face lists.", "operationId": "LargeFaceList_Create", "parameters": [ { @@ -1843,7 +1843,7 @@ } }, "delete": { - "description": "Delete an existing large face list according to faceListId. Persisted face images in the large face list will also be deleted.", + "description": "Delete a specified large face list.", "operationId": "LargeFaceList_Delete", "parameters": [ { @@ -1909,7 +1909,7 @@ { "$ref": "#/parameters/returnRecognitionModel" } - ], + ], "responses": { "200": { "description": "A successful call returns an array of largeFaceList.", @@ -1966,7 +1966,7 @@ }, "/largefacelists/{largeFaceListId}/persistedfaces/{persistedFaceId}": { "delete": { - "description": "Delete an existing face from a large face list (given by a persistedFaceId and a largeFaceListId). Persisted image related to the face will also be deleted.", + "description": "Delete a face from a large face list by specified largeFaceListId and persistedFaceId.\n
Adding/deleting faces to/from a same large face list are processed sequentially and to/from different large face lists are in parallel.", "operationId": "LargeFaceList_DeleteFace", "parameters": [ { @@ -2071,7 +2071,7 @@ }, "/largefacelists/{largeFaceListId}/persistedfaces": { "post": { - "description": "Add a face to a large face list. The input face is specified as an image with a targetFace rectangle. It returns a persistedFaceId representing the added face, and persistedFaceId will not expire.", + "description": "Add a face to a specified large face list, up to 1,000,000 faces.\n
To deal with an image contains multiple faces, input face can be specified as an image with a targetFace rectangle. It returns a persistedFaceId representing the added face. No image will be stored. Only the extracted face feature will be stored on server until [LargeFaceList Face - Delete](/docs/services/563879b61984550e40cbbe8d/operations/5a158c8ad2de3616c086f2d4) or [LargeFaceList - Delete](/docs/services/563879b61984550e40cbbe8d/operations/5a1580d5d2de3616c086f2cd) is called.\n
Note persistedFaceId is different from faceId generated by [Face - Detect](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395236).\n* Higher face image quality means better recognition precision. Please consider high-quality faces: frontal, clear, and face size is 200x200 pixels (100 pixels between eyes) or bigger.\n* JPEG, PNG, GIF (the first frame), and BMP format are supported. The allowed image file size is from 1KB to 6MB.\n* \"targetFace\" rectangle should contain one face. Zero or multiple faces will be regarded as an error. If the provided \"targetFace\" rectangle is not returned from [Face - Detect](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395236), there’s no guarantee to detect and add the face successfully.\n* Out of detectable face size (36x36 - 4096x4096 pixels), large head-pose, or large occlusions will cause failures.\n* Adding/deleting faces to/from a same face list are processed sequentially and to/from different face lists are in parallel.\n\nQuota:\n* Free-tier subscription quota: 1,000 faces per large face list.\n* S0-tier subscription quota: 1,000,000 faces per large face list.", "operationId": "LargeFaceList_AddFaceFromUrl", "parameters": [ { diff --git a/specification/cognitiveservices/data-plane/Face/stable/v1.0/examples/DetectWithStream.json b/specification/cognitiveservices/data-plane/Face/stable/v1.0/examples/DetectWithStream.json index 96731b34b87d..8f9b1e7e3022 100644 --- a/specification/cognitiveservices/data-plane/Face/stable/v1.0/examples/DetectWithStream.json +++ b/specification/cognitiveservices/data-plane/Face/stable/v1.0/examples/DetectWithStream.json @@ -158,7 +158,7 @@ "headPose": { "roll": 2.1, "yaw": 3, - "pitch": 0 + "pitch": 1.6 }, "emotion": { "anger": 0.575, diff --git a/specification/cognitiveservices/data-plane/Face/stable/v1.0/examples/DetectWithUrl.json b/specification/cognitiveservices/data-plane/Face/stable/v1.0/examples/DetectWithUrl.json index 306bf10d3a8e..1ecab58448a0 100644 --- a/specification/cognitiveservices/data-plane/Face/stable/v1.0/examples/DetectWithUrl.json +++ b/specification/cognitiveservices/data-plane/Face/stable/v1.0/examples/DetectWithUrl.json @@ -158,7 +158,7 @@ "headPose": { "roll": 2.1, "yaw": 3, - "pitch": 0 + "pitch": 1.6 }, "emotion": { "anger": 0.575, diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/LUIS-Authoring.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/LUIS-Authoring.json index 3323076ea4dd..67c96ed4915e 100644 --- a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/LUIS-Authoring.json +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/LUIS-Authoring.json @@ -8943,7 +8943,6 @@ "Prebuilt Entity Extractor", "Intent Classifier", "Pattern.Any Entity Extractor", - "Regular Expression Entity Extractor", "Closed List Entity Extractor", "Regex Entity Extractor" ] diff --git a/specification/cognitiveservices/data-plane/LUIS/Runtime/preview/v3.0/LUIS-Runtime.json b/specification/cognitiveservices/data-plane/LUIS/Runtime/preview/v3.0/LUIS-Runtime.json new file mode 100644 index 000000000000..7b4aff08332b --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Runtime/preview/v3.0/LUIS-Runtime.json @@ -0,0 +1,531 @@ +{ + "swagger": "2.0", + "info": { + "version": "3.0-preview", + "title": "LUIS Runtime Client" + }, + "x-ms-parameterized-host": { + "hostTemplate": "{Endpoint}/luis/v3.0-preview", + "useSchemePrefix": false, + "parameters": [ + { + "$ref": "#/parameters/Endpoint" + } + ] + }, + "securityDefinitions": { + "apiKeyHeader": { + "type": "apiKey", + "name": "Ocp-Apim-Subscription-Key", + "in": "header" + } + }, + "security": [ + { + "apiKeyHeader": [] + } + ], + "paths": { + "/apps/{appId}/versions/{versionId}/predict": { + "get": { + "description": "Gets the predictions for an application version.", + "operationId": "Prediction_GetVersionPredictionGET", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/Query" + }, + { + "$ref": "#/parameters/Verbose" + }, + { + "$ref": "#/parameters/ShowAllIntents" + }, + { + "$ref": "#/parameters/Log" + } + ], + "responses": { + "200": { + "description": "The prediction for the supplied query", + "schema": { + "$ref": "#/definitions/PredictionResponse" + } + }, + "default": { + "description": "unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Get Version Predictions From Endpoint Via Get request": { + "$ref": "./examples/prediction/SuccessfulGetVersionPredictionsFromEndpointViaGetRequest.json" + } + } + }, + "post": { + "description": "Gets the predictions for an application version.", + "operationId": "Prediction_GetVersionPrediction", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/Verbose" + }, + { + "$ref": "#/parameters/ShowAllIntents" + }, + { + "$ref": "#/parameters/Log" + }, + { + "$ref": "#/parameters/PredictionRequest" + } + ], + "responses": { + "200": { + "description": "The prediction for the supplied query", + "schema": { + "$ref": "#/definitions/PredictionResponse" + } + }, + "default": { + "description": "unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Get Version Predictions From Endpoint Via Post request": { + "$ref": "./examples/prediction/SuccessfulGetVersionPredictionsFromEndpointViaPostRequest.json" + } + } + } + }, + "/apps/{appId}/slots/{slotName}/predict": { + "get": { + "description": "Gets the predictions for an application slot.", + "operationId": "Prediction_GetSlotPredictionGET", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/SlotNameInPath" + }, + { + "$ref": "#/parameters/Query" + }, + { + "$ref": "#/parameters/Verbose" + }, + { + "$ref": "#/parameters/ShowAllIntents" + }, + { + "$ref": "#/parameters/Log" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The prediction for the supplied query", + "schema": { + "$ref": "#/definitions/PredictionResponse" + } + }, + "default": { + "description": "unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Successful Get Slot Predictions From Endpoint Via Get request": { + "$ref": "./examples/prediction/SuccessfulGetSlotPredictionsFromEndpointViaGetRequest.json" + } + } + }, + "post": { + "description": "Gets the predictions for an application slot.", + "operationId": "Prediction_GetSlotPrediction", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/SlotNameInPath" + }, + { + "$ref": "#/parameters/Verbose" + }, + { + "$ref": "#/parameters/ShowAllIntents" + }, + { + "$ref": "#/parameters/Log" + }, + { + "$ref": "#/parameters/PredictionRequest" + } + ], + "responses": { + "200": { + "description": "The prediction for the supplied query", + "schema": { + "$ref": "#/definitions/PredictionResponse" + } + }, + "default": { + "description": "unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Get Slot Predictions From Endpoint Via Post request": { + "$ref": "./examples/prediction/SuccessfulGetSlotPredictionsFromEndpointViaPostRequest.json" + } + } + } + } + }, + "definitions": { + "PredictionRequest": { + "type": "object", + "description": "Represents the prediction request parameters.", + "required": [ + "query" + ], + "properties": { + "query": { + "description": "The query to predict", + "type": "string" + }, + "options": { + "description": "The custom options defined for this request.", + "$ref": "#/definitions/PredictionRequestOptions" + }, + "externalEntities": { + "description": "The externally predicted entities for this request", + "type": "array", + "items": { + "$ref": "#/definitions/ExternalEntity" + } + }, + "dynamicLists": { + "description": "The dynamically created list entities for this request", + "type": "array", + "items": { + "$ref": "#/definitions/DynamicList" + } + } + } + }, + "PredictionRequestOptions": { + "type": "object", + "description": "The custom options for the prediction request.", + "properties": { + "datetimeReference": { + "type": "string", + "format": "date-time", + "description": "The reference DateTime used for predicting datetime entities." + }, + "overridePredictions": { + "type": "boolean", + "description": "Whether to make the external entities resolution override the predictions if an overlap occurs." + } + } + }, + "PredictionResponse": { + "type": "object", + "description": "Represents the prediction response.", + "required": [ + "query", + "prediction" + ], + "properties": { + "query": { + "type": "string", + "description": "The query used in the prediction." + }, + "prediction": { + "description": "The prediction of the requested query.", + "$ref": "#/definitions/Prediction" + } + } + }, + "Prediction": { + "type": "object", + "description": "Represents the prediction of a query.", + "required": [ + "normalizedQuery", + "topIntent", + "intents", + "entities" + ], + "properties": { + "normalizedQuery": { + "type": "string", + "description": "The query after pre-processing and normalization." + }, + "alteredQuery": { + "type": "string", + "description": "The query after spell checking. Only set if spell check was enabled and a spelling mistake was found." + }, + "topIntent": { + "type": "string", + "description": "The name of the top scoring intent." + }, + "intents": { + "type": "object", + "description": "A dictionary representing the intents that fired.", + "additionalProperties": { + "$ref": "#/definitions/Intent" + } + }, + "entities": { + "type": "object", + "description": "The dictionary representing the entities that fired.", + "additionalProperties": {} + }, + "sentiment": { + "description": "The result of the sentiment analysis.", + "$ref": "#/definitions/Sentiment" + } + } + }, + "Intent": { + "type": "object", + "description": "Represents an intent prediction.", + "properties": { + "score": { + "type": "number", + "description": "The score of the fired intent." + }, + "childApp": { + "description": "The prediction of the dispatched application.", + "$ref": "#/definitions/Prediction" + } + } + }, + "Sentiment": { + "type": "object", + "description": "The result of the sentiment analaysis.", + "required": [ + "score" + ], + "properties": { + "score": { + "type": "number", + "description": "The sentiment score of the query." + }, + "label": { + "type": "string", + "description": "The label of the sentiment analysis result." + } + } + }, + "ExternalEntity": { + "type": "object", + "description": "Defines a user perdicted entity that extends an already existing one.", + "required": [ + "entityName", + "startIndex", + "entityLength" + ], + "properties": { + "entityName": { + "type": "string", + "description": "The name of the entity to extend." + }, + "startIndex": { + "type": "integer", + "description": "The start character index of the predicted entity." + }, + "entityLength": { + "type": "integer", + "description": "The length of the predicted entity." + }, + "resolution": { + "description": "A user supplied custom resolution to return as the entity's prediction." + } + } + }, + "DynamicList": { + "type": "object", + "description": "Defines an extension for a list entity.", + "required": [ + "listEntityName", + "requestLists" + ], + "properties": { + "listEntityName": { + "type": "string", + "description": "The name of the list entity to extend." + }, + "requestLists": { + "type": "array", + "description": "The lists to append on the extended list entity.", + "items": { + "$ref": "#/definitions/RequestList" + } + } + } + }, + "RequestList": { + "type": "object", + "description": "Defines a sub-list to append to an existing list entity.", + "required": [ + "canonicalForm" + ], + "properties": { + "name": { + "type": "string", + "description": "The name of the sub-list." + }, + "canonicalForm": { + "type": "string", + "description": "The canonical form of the sub-list." + }, + "synonyms": { + "type": "array", + "description": "The synonyms of the canonical form.", + "items": { + "type": "string" + } + } + } + }, + "Error": { + "type": "object", + "description": "Represents the error that occurred.", + "required": [ + "error" + ], + "properties": { + "error": { + "$ref": "#/definitions/ErrorBody" + } + } + }, + "ErrorBody": { + "type": "object", + "description": "Represents the definition of the error that occurred.", + "required": [ + "code", + "message" + ], + "properties": { + "code": { + "type": "string", + "description": "The error code." + }, + "message": { + "type": "string", + "description": "The error message." + } + } + } + }, + "parameters": { + "AppIdInPath": { + "name": "appId", + "in": "path", + "required": true, + "type": "string", + "format": "uuid", + "description": "The application ID.", + "x-ms-parameter-location": "method" + }, + "VersionIdInPath": { + "name": "versionId", + "in": "path", + "description": "The application version ID.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "SlotNameInPath": { + "name": "slotName", + "in": "path", + "description": "The application slot name.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "Query": { + "name": "query", + "in": "query", + "description": "The query to predict.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "Verbose": { + "name": "verbose", + "in": "query", + "description": "Indicates whether to get extra metadata for the entities predictions or not.", + "type": "boolean", + "x-ms-parameter-location": "method" + }, + "ShowAllIntents": { + "name": "show-all-intents", + "in": "query", + "description": "Indicates whether to return all the intents in the response or just the top intent.", + "type": "boolean", + "x-ms-parameter-location": "method" + }, + "Log": { + "name": "log", + "in": "query", + "description": "Indicates whether to log the endpoint query or not.", + "type": "boolean", + "x-ms-parameter-location": "method" + }, + "PredictionRequest": { + "name": "predictionRequest", + "in": "body", + "description": "The prediction request parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/PredictionRequest" + }, + "x-ms-parameter-location": "method" + }, + "Endpoint": { + "name": "Endpoint", + "description": "Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com).", + "x-ms-parameter-location": "client", + "required": true, + "type": "string", + "in": "path", + "x-ms-skip-url-encoding": true + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/LUIS/Runtime/preview/v3.0/examples/prediction/SuccessfulGetSlotPredictionsFromEndpointViaGetRequest.json b/specification/cognitiveservices/data-plane/LUIS/Runtime/preview/v3.0/examples/prediction/SuccessfulGetSlotPredictionsFromEndpointViaGetRequest.json new file mode 100644 index 000000000000..3105ad869ad5 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Runtime/preview/v3.0/examples/prediction/SuccessfulGetSlotPredictionsFromEndpointViaGetRequest.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{Subscription Key}", + "appId": "{Application Id}", + "slotName": "{Slot Name}", + "query": "forward to frank 30 dollars through HSBC" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "query": "forward to frank 30 dollars through HSBC", + "prediction": { + "normalizedQuery": "forward to frank 30 dollars through hsbc", + "topIntent": "give", + "intents": { + "give": { + "score": 0.943442 + } + }, + "entities": { + "frank": [ + "frank" + ], + "number": [ + 30 + ], + "money": [ + { + "unit": "Dollar", + "value": 30 + } + ], + "Bank": [ + "HSBC" + ] + }, + "sentiment": { + "label": "positive", + "score": 0.9163064 + } + } + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/LUIS/Runtime/preview/v3.0/examples/prediction/SuccessfulGetSlotPredictionsFromEndpointViaPostRequest.json b/specification/cognitiveservices/data-plane/LUIS/Runtime/preview/v3.0/examples/prediction/SuccessfulGetSlotPredictionsFromEndpointViaPostRequest.json new file mode 100644 index 000000000000..d9fe1dca2d4f --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Runtime/preview/v3.0/examples/prediction/SuccessfulGetSlotPredictionsFromEndpointViaPostRequest.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{Subscription Key}", + "appId": "{Application Id}", + "slotName": "{Slot Name}", + "predictionRequest": { + "query": "forward to frank 30 dollars through HSBC", + "options": { + "datetimeReference": "2015-02-13T13:15:00" + }, + "externalEntities": [ + { + "entityName": "Bank", + "startIndex": 36, + "entityLength": 4, + "resolution": { + "text": "International Bank" + } + } + ], + "dynamicLists": [ + { + "listEntityName": "Employees", + "requestLists": [ + { + "name": "Management", + "canonicalForm": "Frank", + "synonyms": [] + } + ] + } + ] + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "query": "forward to frank 30 dollars through HSBC", + "prediction": { + "normalizedQuery": "forward to frank 30 dollars through hsbc", + "topIntent": "give", + "intents": { + "give": { + "score": 0.943442 + } + }, + "entities": { + "Employees": [ + [ "frank" ] + ], + "number": [ + 30 + ], + "money": [ + { + "unit": "Dollar", + "value": 30 + } + ], + "Bank": [ + { + "text": "International Bank" + } + ] + }, + "sentiment": { + "label": "positive", + "score": 0.9163064 + } + } + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/LUIS/Runtime/preview/v3.0/examples/prediction/SuccessfulGetVersionPredictionsFromEndpointViaGetRequest.json b/specification/cognitiveservices/data-plane/LUIS/Runtime/preview/v3.0/examples/prediction/SuccessfulGetVersionPredictionsFromEndpointViaGetRequest.json new file mode 100644 index 000000000000..2a930ca9fa8f --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Runtime/preview/v3.0/examples/prediction/SuccessfulGetVersionPredictionsFromEndpointViaGetRequest.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{Subscription Key}", + "appId": "{Application Id}", + "versionId": "{Version Id}", + "query": "forward to frank 30 dollars through HSBC" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "query": "forward to frank 30 dollars through HSBC", + "prediction": { + "normalizedQuery": "forward to frank 30 dollars through hsbc", + "topIntent": "give", + "intents": { + "give": { + "score": 0.943442 + } + }, + "entities": { + "Employees": [ + [ "frank" ] + ], + "number": [ + 30 + ], + "money": [ + { + "unit": "Dollar", + "value": 30 + } + ], + "Bank": [ + { + "text": "International Bank" + } + ] + }, + "sentiment": { + "label": "positive", + "score": 0.9163064 + } + } + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/LUIS/Runtime/preview/v3.0/examples/prediction/SuccessfulGetVersionPredictionsFromEndpointViaPostRequest.json b/specification/cognitiveservices/data-plane/LUIS/Runtime/preview/v3.0/examples/prediction/SuccessfulGetVersionPredictionsFromEndpointViaPostRequest.json new file mode 100644 index 000000000000..4188b3e2345c --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Runtime/preview/v3.0/examples/prediction/SuccessfulGetVersionPredictionsFromEndpointViaPostRequest.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{Subscription Key}", + "appId": "{Application Id}", + "versionId": "{Version Id}", + "predictionRequest": { + "query": "forward to frank 30 dollars through HSBC", + "options": { + "datetimeReference": "2015-02-13T13:15:00" + }, + "externalEntities": [ + { + "entityName": "Bank", + "startIndex": 36, + "entityLength": 4, + "resolution": { + "text": "International Bank" + } + } + ], + "dynamicLists": [ + { + "listEntityName": "Employees", + "requestLists": [ + { + "name": "Management", + "canonicalForm": "Frank", + "synonyms": [] + } + ] + } + ] + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "query": "forward to frank 30 dollars through HSBC", + "prediction": { + "normalizedQuery": "forward to frank 30 dollars through hsbc", + "topIntent": "give", + "intents": { + "give": { + "score": 0.943442 + } + }, + "entities": { + "Employees": [ + [ "frank" ] + ], + "number": [ + 30 + ], + "money": [ + { + "unit": "Dollar", + "value": 30 + } + ], + "Bank": [ + { + "text": "International Bank" + } + ] + }, + "sentiment": { + "label": "positive", + "score": 0.9163064 + } + } + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/LUIS/Runtime/readme.go.md b/specification/cognitiveservices/data-plane/LUIS/Runtime/readme.go.md index 810dbbba0f0b..ca2fd7b2b082 100644 --- a/specification/cognitiveservices/data-plane/LUIS/Runtime/readme.go.md +++ b/specification/cognitiveservices/data-plane/LUIS/Runtime/readme.go.md @@ -23,4 +23,13 @@ Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'runtime_3_0_preview' && $(go) +output-folder: $(go-sdk-folder)/services/cognitiveservices/v3.0-preview/luis/$(namespace) ``` \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/LUIS/Runtime/readme.md b/specification/cognitiveservices/data-plane/LUIS/Runtime/readme.md index 2ffe8859e39a..e76e7b6003ca 100644 --- a/specification/cognitiveservices/data-plane/LUIS/Runtime/readme.md +++ b/specification/cognitiveservices/data-plane/LUIS/Runtime/readme.md @@ -5,12 +5,12 @@ Configuration for generating LUIS Runtime SDK. ``` yaml -tag: runtime_2_0 +tag: runtime_3_0_preview add-credentials: true openapi-type: data-plane ``` -The current release for the Runtime Endpoint is `runtime_2_0`. +The current release for the Runtime Endpoint is `runtime_3_0_preview`. # Releases @@ -25,6 +25,18 @@ directive: remove-operation: Prediction_Resolve2 ``` +## Runtime 3.0-preview +These settings apply only when `--tag=runtime_3_0_preview` is specified on the command line. + +``` yaml $(tag) == 'runtime_3_0_preview' +input-file: preview/v3.0/LUIS-Runtime.json + +# remove the GET APIs from code-generation (since the POST and GET operations are functionally identical) +directive: + - remove-operation: Prediction_GetSlotPredictionGET + - remove-operation: Prediction_GetVersionPredictionGET +``` + --- # Code Generation @@ -42,7 +54,7 @@ swagger-to-sdk: - repo: azure-sdk-for-node ``` -### Runtime 2.0 - CSharp Settings +### CSharp These settings apply only when `--csharp` is specified on the command line. ``` yaml $(csharp) csharp: diff --git a/specification/cognitiveservices/data-plane/Personalizer/preview/v1.0/Personalizer.json b/specification/cognitiveservices/data-plane/Personalizer/preview/v1.0/Personalizer.json new file mode 100644 index 000000000000..88a3a5f1320b --- /dev/null +++ b/specification/cognitiveservices/data-plane/Personalizer/preview/v1.0/Personalizer.json @@ -0,0 +1,1052 @@ +{ + "swagger": "2.0", + "info": { + "version": "v1.0", + "title": "Personalizer Client", + "description": "Personalizer Service is an Azure Cognitive Service that makes it easy to target content and experiences without complex pre-analysis or cleanup of past data. Given a context and featurized content, the Personalizer Service returns your content in a ranked list. As rewards are sent in response to the ranked list, the reinforcement learning algorithm will improve the model and improve performance of future rank calls." + }, + "basePath": "/personalizer/v1.0", + "paths": { + "/configurations/service": { + "get": { + "tags": [ + "Configurations" + ], + "summary": "Get the service configuration.", + "operationId": "ServiceConfiguration_Get", + "consumes": [ + + ], + "produces": [ + "application/json" + ], + "parameters": [ + + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ServiceConfiguration" + } + } + }, + "x-ms-examples": { + "Successful ServiceConfiguration_Get request": { + "$ref": "./examples/ServiceConfiguration_Get.json" + } + } + }, + "patch": { + "tags": [ + "Configurations" + ], + "summary": "Update the service configuration.", + "operationId": "ServiceConfiguration_Update", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "config", + "in": "body", + "description": "The personalizer service configuration.", + "required": true, + "schema": { + "$ref": "#/definitions/ServiceConfiguration" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ServiceConfiguration" + } + }, + "default": { + "description": "*** Error Responses: ***\\n\\n * 400 Invalid arguments.\\n\\n * 404 ResourceNotFound." + } + }, + "x-ms-examples": { + "Successful ServiceConfiguration_Update request": { + "$ref": "./examples/ServiceConfiguration_Update.json" + } + } + } + }, + "/configurations/policy": { + "get": { + "tags": [ + "Configurations" + ], + "summary": "Get the policy configuration.", + "operationId": "Policy_Get", + "consumes": [ + + ], + "produces": [ + "application/json" + ], + "parameters": [ + + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/PolicyContract" + } + } + }, + "x-ms-examples": { + "Successful Policy_Get request": { + "$ref": "./examples/Policy_Get.json" + } + } + }, + "delete": { + "tags": [ + "Configurations" + ], + "summary": "Delete the current policy.", + "operationId": "Policy_Delete", + "consumes": [ + + ], + "produces": [ + "application/json" + ], + "parameters": [ + + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/PolicyContract" + } + } + }, + "x-ms-examples": { + "Successful Policy_Delete request": { + "$ref": "./examples/Policy_Delete.json" + } + } + }, + "patch": { + "tags": [ + "Configurations" + ], + "summary": "Update the policy configuration.", + "operationId": "Policy_Update", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "policy", + "in": "body", + "description": "The policy configuration.", + "required": true, + "schema": { + "$ref": "#/definitions/PolicyContract" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/PolicyContract" + } + }, + "default": { + "description": "*** Error Responses: ***\\n\\n * 400 Invalid arguments.\\n\\n * 404 ResourceNotFound." + } + }, + "x-ms-examples": { + "Successful Policy_Update request": { + "$ref": "./examples/Policy_Update.json" + } + } + } + }, + "/evaluations": { + "get": { + "tags": [ + "Evaluations" + ], + "summary": "List all submitted evaluations.", + "operationId": "Evaluations_List", + "consumes": [ + + ], + "produces": [ + "application/json" + ], + "parameters": [ + + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/Evaluation" + } + } + } + }, + "x-ms-examples": { + "Successful Evaluations_List request": { + "$ref": "./examples/Evaluations_List.json" + } + } + }, + "post": { + "tags": [ + "Evaluations" + ], + "summary": "Submit a new evaluation.", + "operationId": "Evaluations_Create", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "evaluation", + "in": "body", + "description": "The evaluation job definition.", + "required": true, + "schema": { + "$ref": "#/definitions/EvaluationContract" + } + } + ], + "responses": { + "201": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Evaluation" + } + }, + "default": { + "description": "*** Error Responses: ***\\n\\n * 400 Invalid arguments.\\n\\n * 404 ResourceNotFound." + } + }, + "x-ms-examples": { + "Successful Evaluations_Create request": { + "$ref": "./examples/Evaluations_Create.json" + } + } + } + }, + "/evaluations/{evaluationId}": { + "get": { + "tags": [ + "Evaluations" + ], + "summary": "Get the evaluation associated with the ID.", + "operationId": "Evaluations_Get", + "consumes": [ + + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "evaluationId", + "in": "path", + "description": "ID of the evaluation in question.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Evaluation" + } + }, + "default": { + "description": "*** Error Responses: ***\\n\\n * 400 Invalid arguments.\\n\\n * 404 ResourceNotFound." + } + }, + "x-ms-examples": { + "Successful Evaluations_Get request": { + "$ref": "./examples/Evaluations_Get.json" + } + } + }, + "delete": { + "tags": [ + "Evaluations" + ], + "summary": "Delete the evaluation associated with the ID.", + "operationId": "Evaluations_Delete", + "consumes": [ + + ], + "produces": [ + + ], + "parameters": [ + { + "name": "evaluationId", + "in": "path", + "description": "ID of the evaluation to delete.", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success" + } + }, + "x-ms-examples": { + "Successful Evaluations_Delete request": { + "$ref": "./examples/Evaluations_Delete.json" + } + } + } + }, + "/events/{eventId}/reward": { + "post": { + "tags": [ + "Events" + ], + "summary": "Report reward to allocate to the top ranked action for the specified event.", + "operationId": "Events_Reward", + "consumes": [ + "application/json" + ], + "produces": [ + + ], + "parameters": [ + { + "name": "eventId", + "in": "path", + "description": "The event id this reward applies to.", + "required": true, + "type": "string" + }, + { + "name": "reward", + "in": "body", + "description": "The reward should be a floating point number.", + "required": true, + "schema": { + "$ref": "#/definitions/RewardRequest" + } + } + ], + "responses": { + "204": { + "description": "Success" + }, + "default": { + "description": "*** Error Responses: ***\\n\\n * 400 Invalid arguments.\\n\\n * 404 ResourceNotFound." + } + }, + "x-ms-examples": { + "Successful Events_Reward request": { + "$ref": "./examples/Events_Reward.json" + } + } + } + }, + "/events/{eventId}/activate": { + "post": { + "tags": [ + "Events" + ], + "summary": "Report that the specified event was actually displayed to the user and a reward should be expected for it.", + "operationId": "Events_Activate", + "consumes": [ + + ], + "produces": [ + + ], + "parameters": [ + { + "name": "eventId", + "in": "path", + "description": "The event ID this activation applies to.", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success" + }, + "default": { + "description": "*** Error Responses: ***\\n\\n * 400 Invalid arguments.\\n\\n * 404 ResourceNotFound." + } + }, + "x-ms-examples": { + "Successful Events_Activate request": { + "$ref": "./examples/Events_Activate.json" + } + } + } + }, + "/logs": { + "delete": { + "tags": [ + "Logs" + ], + "summary": "Deletes all the logs.", + "operationId": "Log_Delete", + "consumes": [ + + ], + "produces": [ + + ], + "parameters": [ + + ], + "responses": { + "204": { + "description": "Success" + } + }, + "x-ms-examples": { + "Successful Log_Delete request": { + "$ref": "./examples/Log_Delete.json" + } + } + } + }, + "/logs/properties": { + "get": { + "tags": [ + "Logs" + ], + "summary": "Gets logs properties.", + "operationId": "Log_GetProperties", + "consumes": [ + + ], + "produces": [ + "application/json" + ], + "parameters": [ + + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/LogsProperties" + } + }, + "default": { + "description": "*** Error Responses: ***\\n\\n * 400 Invalid arguments.\\n\\n * 404 ResourceNotFound." + } + }, + "x-ms-examples": { + "Successful Log_GetProperties request": { + "$ref": "./examples/Log_GetProperties.json" + } + } + } + }, + "/model": { + "get": { + "tags": [ + "Model" + ], + "summary": "Get current model.", + "operationId": "Model_Get", + "consumes": [ + + ], + "produces": [ + "application/octet-stream" + ], + "parameters": [ + + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "type": "file" + } + } + }, + "x-ms-examples": { + "Successful Model_Get request": { + "$ref": "./examples/Model_Get.json" + } + } + }, + "delete": { + "tags": [ + "Model" + ], + "summary": "Resets the model.", + "operationId": "Model_Delete", + "consumes": [ + + ], + "produces": [ + + ], + "parameters": [ + + ], + "responses": { + "204": { + "description": "Success" + }, + "default": { + "description": "*** Error Responses: ***\\n\\n * 400 Invalid arguments.\\n\\n * 404 ResourceNotFound." + } + }, + "x-ms-examples": { + "Successful Model_Delete request": { + "$ref": "./examples/Model_Delete.json" + } + } + } + }, + "/model/properties": { + "get": { + "tags": [ + "Model" + ], + "summary": "Get model properties.", + "operationId": "Model_GetProperties", + "consumes": [ + + ], + "produces": [ + "application/json" + ], + "parameters": [ + + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ModelProperties" + } + } + }, + "x-ms-examples": { + "Successful Model_GetProperties request": { + "$ref": "./examples/Model_GetProperties.json" + } + } + } + }, + "/rank": { + "post": { + "tags": [ + "Ranking" + ], + "summary": "A Personalizer rank request.", + "operationId": "Events_Rank", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "rankRequest", + "in": "body", + "description": "A Personalizer request.", + "required": true, + "schema": { + "$ref": "#/definitions/RankRequest" + } + } + ], + "responses": { + "201": { + "description": "Success", + "schema": { + "$ref": "#/definitions/RankResponse" + } + }, + "default": { + "description": "*** Error Responses: ***\\n\\n * 400 Invalid arguments.\\n\\n * 404 ResourceNotFound." + } + }, + "x-ms-examples": { + "Successful Events_Rank request": { + "$ref": "./examples/Events_Rank.json" + } + } + } + } + }, + "definitions": { + "ServiceConfiguration": { + "description": "The configuration of the service.", + "required": [ + "rewardWaitTime", + "defaultReward", + "rewardAggregation", + "explorationPercentage", + "modelExportFrequency", + "logRetentionDays" + ], + "type": "object", + "properties": { + "rewardWaitTime": { + "description": "The time span waited until a request is marked with the default reward.", + "type": "string" + }, + "defaultReward": { + "format": "float", + "description": "The reward given if a reward is not received within the specified wait time.", + "maximum": 1, + "minimum": -1, + "type": "number" + }, + "rewardAggregation": { + "description": "The function used to process rewards.", + "type": "string" + }, + "explorationPercentage": { + "format": "float", + "description": "The percentage of rank responses that will use exploration.", + "type": "number" + }, + "modelExportFrequency": { + "description": "The time delay between exporting trained models.", + "type": "string" + }, + "logRetentionDays": { + "format": "int32", + "description": "Number of days historical logs are to be maintained.", + "type": "integer" + } + } + }, + "PolicyContract": { + "description": "Policy specifying how to train the model.", + "required": [ + "name", + "arguments" + ], + "type": "object", + "properties": { + "name": { + "description": "Name of the Policy.", + "type": "string" + }, + "arguments": { + "description": "Arguments of the Policy.", + "type": "string" + } + } + }, + "EvaluationContract": { + "description": "A counterfactual evaluation.", + "required": [ + "name", + "startTime", + "endTime", + "policies" + ], + "type": "object", + "properties": { + "enableOfflineExperimentation": { + "description": "True if the evaluation should explore for a more optimal policy.", + "type": "boolean" + }, + "name": { + "description": "The name of the evaluation.", + "type": "string" + }, + "startTime": { + "format": "date-time", + "description": "The start time of the evaluation.", + "type": "string" + }, + "endTime": { + "format": "date-time", + "type": "string" + }, + "policies": { + "description": "Additional policies to evaluate.", + "type": "array", + "items": { + "$ref": "#/definitions/PolicyContract" + } + } + } + }, + "Evaluation": { + "type": "object", + "properties": { + "id": { + "type": "string", + "readOnly": true + }, + "name": { + "type": "string", + "readOnly": true + }, + "startTime": { + "format": "date-time", + "type": "string", + "readOnly": true + }, + "endTime": { + "format": "date-time", + "type": "string", + "readOnly": true + }, + "jobId": { + "type": "string", + "readOnly": true + }, + "status": { + "enum": [ + "completed", + "pending", + "failed", + "notSubmitted" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "EvaluationJobStatus", + "modelAsString": true + } + }, + "policyResults": { + "type": "array", + "items": { + "$ref": "#/definitions/PolicyResult" + } + } + } + }, + "PolicyResult": { + "type": "object", + "properties": { + "name": { + "type": "string", + "readOnly": true + }, + "arguments": { + "type": "string", + "readOnly": true + }, + "summary": { + "type": "array", + "items": { + "$ref": "#/definitions/PolicyResultSummary" + }, + "readOnly": true + }, + "totalSummary": { + "allOf": [ + { + "$ref": "#/definitions/PolicyResultSummary" + } + ], + "readOnly": true + } + } + }, + "PolicyResultSummary": { + "type": "object", + "properties": { + "timeStamp": { + "format": "date-time", + "type": "string", + "readOnly": true + }, + "ipsEstimatorNumerator": { + "format": "float", + "type": "number", + "readOnly": true + }, + "ipsEstimatorDenominator": { + "format": "float", + "type": "number", + "readOnly": true + }, + "snipsEstimatorDenominator": { + "format": "float", + "type": "number", + "readOnly": true + }, + "aggregateTimeWindow": { + "type": "string", + "readOnly": true + }, + "nonZeroProbability": { + "format": "float", + "type": "number" + }, + "confidenceInterval": { + "format": "float", + "type": "number", + "readOnly": true + }, + "sumOfSquares": { + "format": "float", + "type": "number", + "readOnly": true + } + } + }, + "RewardRequest": { + "description": "Reward given to a rank response.", + "type": "object", + "properties": { + "value": { + "format": "float", + "description": "Reward to be assigned to an action. Value must be between -1 and 1 inclusive.", + "type": "number" + } + } + }, + "LogsProperties": { + "type": "object", + "properties": { + "dateRange": { + "allOf": [ + { + "$ref": "#/definitions/DateRange" + } + ], + "readOnly": true + } + } + }, + "DateRange": { + "type": "object", + "properties": { + "from": { + "format": "date-time", + "type": "string", + "readOnly": true + }, + "to": { + "format": "date-time", + "type": "string", + "readOnly": true + } + } + }, + "ModelProperties": { + "type": "object", + "properties": { + "creationTime": { + "format": "date-time", + "type": "string", + "readOnly": true + }, + "lastModifiedTime": { + "format": "date-time", + "type": "string", + "readOnly": true + } + } + }, + "RankRequest": { + "description": "Request a set of actions to be ranked by the Personalizer service.", + "required": [ + "actions" + ], + "type": "object", + "properties": { + "contextFeatures": { + "description": "Features of the context used for Personalizer as a\r\ndictionary of dictionaries. This depends on the application, and\r\ntypically includes features about the current user, their\r\ndevice, profile information, data about time and date, etc.", + "type": "array", + "items": { + "type": "object" + } + }, + "actions": { + "description": "The set of actions the Personalizer service can pick from.\r\nThe set should not contain more than 50 actions.\r\nThe order of the actions does not affect the rank result but the order\r\nshould match the sequence your application would have used to display them.", + "type": "array", + "items": { + "$ref": "#/definitions/RankableAction" + } + }, + "excludedActions": { + "description": "The set of action ids to exclude from ranking.", + "type": "array", + "items": { + "type": "string" + } + }, + "eventId": { + "description": "Optionally pass an eventId that uniquely identifies this Rank event. \r\nIf null, the service generates a unique eventId. The eventId will be used for\r\nassociating this request with its reward, as well as seeding the pseudo-random\r\ngenerator when making a Personalizer call.", + "type": "string" + }, + "deferActivation": { + "description": "Send false if the user will see the rank results, therefore\r\nPersonalizer will expect a Reward call, otherwise it will assign the default\r\nReward to the event. Send true if it is possible the user will not see the\r\nrank results, because the page is rendering later, or the Rank results may be\r\noverridden by code further downstream.", + "default": false, + "type": "boolean" + } + } + }, + "RankableAction": { + "description": "An action with it\u0027s associated features used for ranking.", + "required": [ + "id", + "features" + ], + "type": "object", + "properties": { + "id": { + "description": "Id of the action.", + "type": "string" + }, + "features": { + "description": "List of dictionaries containing features.", + "type": "array", + "items": { + "type": "object" + } + } + } + }, + "RankResponse": { + "description": "A resulting ordered list of actions that result from a rank request.", + "type": "object", + "properties": { + "ranking": { + "description": "The calculated ranking for the current request.", + "type": "array", + "items": { + "$ref": "#/definitions/RankedAction" + }, + "readOnly": true + }, + "eventId": { + "description": "The eventId for the round trip from request to response.", + "type": "string", + "readOnly": true + }, + "rewardActionId": { + "description": "The action chosen by the Personalizer service. This is the action for which to report the reward. This might not be the \r\nfirst found in \u0027ranking\u0027 if an action in the request in first position was part of the excluded ids.", + "type": "string", + "readOnly": true + } + } + }, + "RankedAction": { + "description": "A ranked action with its resulting probability.", + "type": "object", + "properties": { + "id": { + "description": "Id of the action", + "type": "string", + "readOnly": true + }, + "probability": { + "format": "float", + "description": "Probability of the action", + "type": "number", + "readOnly": true + } + } + }, + "ContainerStatus": { + "type": "object", + "properties": { + "service": { + "type": "string" + }, + "apiStatus": { + "type": "string" + }, + "apiStatusMessage": { + "type": "string" + } + } + } + }, + "parameters": { + "Endpoint": { + "name": "Endpoint", + "in": "path", + "description": "Supported Cognitive Services endpoint.", + "required": true, + "type": "string", + "x-ms-parameter-location": "client", + "x-ms-skip-url-encoding": true + } + }, + "securityDefinitions": { + "apim_key": { + "name": "Ocp-Apim-Subscription-Key", + "in": "header", + "type": "apiKey" + } + }, + "security": [ + { + "apim_key": [ + + ] + } + ], + "tags": [ + { + "name": "Evaluations", + "description": "Manages counterfactual evaluation operations." + }, + { + "name": "Model", + "description": "Manages reinforcement learning configuration operations." + }, + { + "name": "Configurations", + "description": "Manages configuration operations." + }, + { + "name": "Events", + "description": "Manages event operations." + }, + { + "name": "Logs", + "description": "Manages reinforcement learning logs." + }, + { + "name": "Ranking", + "description": "Manages ranking operations." + } + ], + "x-ms-parameterized-host": { + "hostTemplate": "{Endpoint}", + "useSchemePrefix": false, + "parameters": [ + { + "$ref": "#/parameters/Endpoint" + } + ] + } +} diff --git a/specification/cognitiveservices/data-plane/Personalizer/preview/v1.0/examples/Evaluations_Create.json b/specification/cognitiveservices/data-plane/Personalizer/preview/v1.0/examples/Evaluations_Create.json new file mode 100644 index 000000000000..cc9d74df7750 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Personalizer/preview/v1.0/examples/Evaluations_Create.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "evaluation": { + "enableOfflineExperimentation": true, + "name": "myFirstEvaluation", + "startTime": "2018-12-19T00:00:00Z", + "endTime": "2019-01-19T00:00:00Z", + "policies": [ + { + "name": "Custom Policy 1", + "arguments": "--cb_explore_adf --epsilon 0.2 --dsjson --cb_type ips -l 0.5 --l1 1E-07 --power_t 0.5" + } + ] + }, + "Ocp-Apim-Subscription-Key": "{API key}" + }, + "responses": { + "201": { + "body": { + "id": "b58c6d92-b727-48c1-9487-4be2782c9e0a", + "name": "myFirstEvaluation", + "startTime": "2018-12-19T00:00:00Z", + "endTime": "2019-01-19T00:00:00Z", + "status": "completed", + "policyResults": [ + { + "name": "Custom Policy 1", + "arguments": "--cb_explore_adf --epsilon 0.2 --dsjson --cb_type ips -l 0.5 --l1 1E-07 --power_t 0.5" + } + ] + }, + "header": { + + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Personalizer/preview/v1.0/examples/Evaluations_Delete.json b/specification/cognitiveservices/data-plane/Personalizer/preview/v1.0/examples/Evaluations_Delete.json new file mode 100644 index 000000000000..d46ae8afecca --- /dev/null +++ b/specification/cognitiveservices/data-plane/Personalizer/preview/v1.0/examples/Evaluations_Delete.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "evaluationId": "id", + "Ocp-Apim-Subscription-Key": "{API key}" + }, + "responses": { + "204": { + "body": "", + "header": { + + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Personalizer/preview/v1.0/examples/Evaluations_Get.json b/specification/cognitiveservices/data-plane/Personalizer/preview/v1.0/examples/Evaluations_Get.json new file mode 100644 index 000000000000..e50b89b1e871 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Personalizer/preview/v1.0/examples/Evaluations_Get.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "evaluationId": "id", + "Ocp-Apim-Subscription-Key": "{API key}" + }, + "responses": { + "200": { + "body": { + "id": "b58c6d92-b727-48c1-9487-4be2782c9e0a", + "name": "myFirstEvaluation", + "startTime": "2018-12-19T00:00:00Z", + "endTime": "2019-01-19T00:00:00Z", + "status": "completed", + "policyResults": [ + { + "name": "Custom Policy 1", + "arguments": "--cb_explore_adf --epsilon 0.2 --dsjson --cb_type ips -l 0.5 --l1 1E-07 --power_t 0.5", + "summary": [ + { + "timeStamp": "2018-12-19T00:00:00Z", + "ipsEstimatorNumerator": 0.0, + "ipsEstimatorDenominator": 170.0, + "snipsEstimatorDenominator": 308.25, + "aggregateTimeWindow": "00:00:00", + "nonZeroProbability": 64.0, + "confidenceInterval": 0.0, + "sumOfSquares": 0.0 + }, + { + "timeStamp": "2018-12-19T00:05:00Z", + "ipsEstimatorNumerator": 2.2, + "ipsEstimatorDenominator": 196.0, + "snipsEstimatorDenominator": 193.761, + "aggregateTimeWindow": "00:00:00", + "nonZeroProbability": 68.0, + "confidenceInterval": 1.1009, + "sumOfSquares": 2.424 + } + ], + "totalSummary": { + "timeStamp": "2019-01-19T00:00:00Z", + "ipsEstimatorNumerator": 22.2, + "ipsEstimatorDenominator": 1906.0, + "snipsEstimatorDenominator": 1993.761, + "aggregateTimeWindow": "00:00:00", + "nonZeroProbability": 68.0, + "confidenceInterval": 1.1209, + "sumOfSquares": 2.484 + } + } + ] + }, + "header": { + + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Personalizer/preview/v1.0/examples/Evaluations_List.json b/specification/cognitiveservices/data-plane/Personalizer/preview/v1.0/examples/Evaluations_List.json new file mode 100644 index 000000000000..b339945de9c7 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Personalizer/preview/v1.0/examples/Evaluations_List.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "Endpoint": "{Endpoint}" + }, + "responses": { + "200": { + "body": [ + { + "id": "b58c6d92-b727-48c1-9487-4be2782c9e0a", + "name": "myFirstEvaluation", + "startTime": "2018-11-19T00:00:00Z", + "endTime": "2018-12-19T00:00:00Z", + "status": "pending", + "policyResults": [ + { + "name": "Custom Policy 1", + "arguments": "--cb_explore_adf --epsilon 0.2 --dsjson --cb_type ips -l 0.5 --l1 1E-07 --power_t 0.5" + } + ] + }, + { + "id": "21d03972-9130-4be9-8c8b-8ac3ec9b9dd1", + "name": "mySecondEvaluation", + "startTime": "2018-12-19T00:00:00Z", + "endTime": "2019-01-19T00:00:00Z", + "status": "pending", + "policyResults": [ + + ] + } + ], + "header": { + + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Personalizer/preview/v1.0/examples/Events_Activate.json b/specification/cognitiveservices/data-plane/Personalizer/preview/v1.0/examples/Events_Activate.json new file mode 100644 index 000000000000..2274850daf88 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Personalizer/preview/v1.0/examples/Events_Activate.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "eventId": "id", + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}" + }, + "responses": { + "204": { + "body": "", + "header": { + + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Personalizer/preview/v1.0/examples/Events_Rank.json b/specification/cognitiveservices/data-plane/Personalizer/preview/v1.0/examples/Events_Rank.json new file mode 100644 index 000000000000..725c02fe7bc3 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Personalizer/preview/v1.0/examples/Events_Rank.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "rankRequest": { + "contextFeatures": [ + { + "timeOfDay": "Morning" + } + ], + "actions": [ + { + "id": "NewsArticle", + "features": [ + { + "type": "News" + } + ] + }, + { + "id": "SportsArticle", + "features": [ + { + "type": "Sports" + } + ] + }, + { + "id": "EntertainmentArticle", + "features": [ + { + "type": "Entertainment" + } + ] + } + ], + "excludedActions": [ + "SportsArticle" + ], + "eventId": "75269AD0-BFEE-4598-8196-C57383D38E10", + "deferActivation": false + } + }, + "responses": { + "201": { + "body": { + "ranking": [ + { + "id": "EntertainmentArticle", + "probability": 0.8 + }, + { + "id": "SportsArticle", + "probability": 0.0 + }, + { + "id": "NewsArticle", + "probability": 0.2 + } + ], + "eventId": "75269AD0-BFEE-4598-8196-C57383D38E10", + "rewardActionId": "EntertainmentArticle" + }, + "header": { + + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Personalizer/preview/v1.0/examples/Events_Reward.json b/specification/cognitiveservices/data-plane/Personalizer/preview/v1.0/examples/Events_Reward.json new file mode 100644 index 000000000000..8b6db659b300 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Personalizer/preview/v1.0/examples/Events_Reward.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "eventId": "id", + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "reward": { + "value": 1.0 + } + }, + "responses": { + "204": { + "body": "", + "header": { + + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Personalizer/preview/v1.0/examples/Log_Delete.json b/specification/cognitiveservices/data-plane/Personalizer/preview/v1.0/examples/Log_Delete.json new file mode 100644 index 000000000000..62e3f0e62214 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Personalizer/preview/v1.0/examples/Log_Delete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "Endpoint": "{Endpoint}" + }, + "responses": { + "204": { + "body": "", + "header": { + + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Personalizer/preview/v1.0/examples/Log_GetProperties.json b/specification/cognitiveservices/data-plane/Personalizer/preview/v1.0/examples/Log_GetProperties.json new file mode 100644 index 000000000000..ea88ec0bdea4 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Personalizer/preview/v1.0/examples/Log_GetProperties.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "Endpoint": "{Endpoint}" + }, + "responses": { + "200": { + "body": { + "dateRange": { + "from": "2019-01-18T16:00:00-08:00", + "to": "2019-02-18T16:00:00-08:00" + } + }, + "header": { + + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Personalizer/preview/v1.0/examples/Model_Delete.json b/specification/cognitiveservices/data-plane/Personalizer/preview/v1.0/examples/Model_Delete.json new file mode 100644 index 000000000000..62e3f0e62214 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Personalizer/preview/v1.0/examples/Model_Delete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "Endpoint": "{Endpoint}" + }, + "responses": { + "204": { + "body": "", + "header": { + + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Personalizer/preview/v1.0/examples/Model_Get.json b/specification/cognitiveservices/data-plane/Personalizer/preview/v1.0/examples/Model_Get.json new file mode 100644 index 000000000000..532fffa97f3a --- /dev/null +++ b/specification/cognitiveservices/data-plane/Personalizer/preview/v1.0/examples/Model_Get.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "Endpoint": "{Endpoint}" + }, + "responses": { + "200": { + "body": "", + "header": { + + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Personalizer/preview/v1.0/examples/Model_GetProperties.json b/specification/cognitiveservices/data-plane/Personalizer/preview/v1.0/examples/Model_GetProperties.json new file mode 100644 index 000000000000..a8057f27beaa --- /dev/null +++ b/specification/cognitiveservices/data-plane/Personalizer/preview/v1.0/examples/Model_GetProperties.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "Endpoint": "{Endpoint}" + }, + "responses": { + "200": { + "body": { + "creationTime": "2019-01-18T16:00:00-08:00", + "lastModifiedTime": "2019-01-18T16:00:00-08:00" + }, + "header": { + + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Personalizer/preview/v1.0/examples/Policy_Delete.json b/specification/cognitiveservices/data-plane/Personalizer/preview/v1.0/examples/Policy_Delete.json new file mode 100644 index 000000000000..ea4545bf012a --- /dev/null +++ b/specification/cognitiveservices/data-plane/Personalizer/preview/v1.0/examples/Policy_Delete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "Endpoint": "{Endpoint}" + }, + "responses": { + "200": { + "body": { + "name": "myPersonalizer", + "arguments": "--cb_explore_adf --epsilon 0.2 --dsjson --cb_type ips -l 0.5 --l1 1E-07 --power_t 0.5" + }, + "header": { + + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Personalizer/preview/v1.0/examples/Policy_Get.json b/specification/cognitiveservices/data-plane/Personalizer/preview/v1.0/examples/Policy_Get.json new file mode 100644 index 000000000000..ea4545bf012a --- /dev/null +++ b/specification/cognitiveservices/data-plane/Personalizer/preview/v1.0/examples/Policy_Get.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "Endpoint": "{Endpoint}" + }, + "responses": { + "200": { + "body": { + "name": "myPersonalizer", + "arguments": "--cb_explore_adf --epsilon 0.2 --dsjson --cb_type ips -l 0.5 --l1 1E-07 --power_t 0.5" + }, + "header": { + + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Personalizer/preview/v1.0/examples/Policy_Update.json b/specification/cognitiveservices/data-plane/Personalizer/preview/v1.0/examples/Policy_Update.json new file mode 100644 index 000000000000..75f8f8e37779 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Personalizer/preview/v1.0/examples/Policy_Update.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "policy": { + "name": "myPersonalizer", + "arguments": "--cb_explore_adf --epsilon 0.2 --dsjson --cb_type ips -l 0.5 --l1 1E-07 --power_t 0.5" + }, + "Ocp-Apim-Subscription-Key": "{API key}" + }, + "responses": { + "200": { + "body": { + "name": "myPersonalizer", + "arguments": "--cb_explore_adf --epsilon 0.2 --dsjson --cb_type ips -l 0.5 --l1 1E-07 --power_t 0.5" + }, + "header": { + + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Personalizer/preview/v1.0/examples/ServiceConfiguration_Get.json b/specification/cognitiveservices/data-plane/Personalizer/preview/v1.0/examples/ServiceConfiguration_Get.json new file mode 100644 index 000000000000..d0ebdc317b91 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Personalizer/preview/v1.0/examples/ServiceConfiguration_Get.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "Endpoint": "{Endpoint}" + }, + "responses": { + "200": { + "body": { + "rewardWaitTime": "00:10:00", + "defaultReward": 0.0, + "rewardAggregation": "earliest", + "explorationPercentage": 0.2, + "modelExportFrequency": "00:05:00", + "logRetentionDays": 7 + }, + "header": { + + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Personalizer/preview/v1.0/examples/ServiceConfiguration_Update.json b/specification/cognitiveservices/data-plane/Personalizer/preview/v1.0/examples/ServiceConfiguration_Update.json new file mode 100644 index 000000000000..2208aeaa7269 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Personalizer/preview/v1.0/examples/ServiceConfiguration_Update.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "config": { + "rewardWaitTime": "00:10:00", + "defaultReward": 0.0, + "rewardAggregation": "earliest", + "explorationPercentage": 0.2, + "modelExportFrequency": "00:05:00", + "logRetentionDays": 7 + }, + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}" + }, + "responses": { + "200": { + "body": { + "rewardWaitTime": "00:10:00", + "defaultReward": 0.0, + "rewardAggregation": "earliest", + "explorationPercentage": 0.2, + "modelExportFrequency": "00:05:00", + "logRetentionDays": 7 + }, + "header": { + + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Personalizer/readme.md b/specification/cognitiveservices/data-plane/Personalizer/readme.md new file mode 100644 index 000000000000..149333c3217f --- /dev/null +++ b/specification/cognitiveservices/data-plane/Personalizer/readme.md @@ -0,0 +1,52 @@ +# Cognitive Services Personalizer SDK + +> see https://aka.ms/autorest + +Configuration for generating Personalizer SDK. + +The current release is `release_1_0`. + +``` yaml +tag: release_1_0 +add-credentials: true +openapi-type: data-plane +``` +# Releases + +### Release 1.0 +These settings apply only when `--tag=release_1_0` is specified on the command line. + +``` yaml $(tag) == 'release_1_0' +input-file: + - preview/v1.0/Personalizer.json +``` + +## 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 + - repo: azure-sdk-for-java + - repo: azure-sdk-for-go + - repo: azure-sdk-for-js + - repo: azure-sdk-for-node + - repo: azure-sdk-for-ruby + after_scripts: + - bundle install && rake arm:regen_all_profiles['azure_cognitiveservices_personalizer'] +``` + + +## CSharp Settings +These settings apply only when `--csharp` is specified on the command line. +``` yaml $(csharp) +csharp: + license-header: MICROSOFT_MIT_NO_VERSION + azure-arm: false + namespace: Microsoft.Azure.CognitiveServices.Personalizer + output-folder: $(csharp-sdks-folder)/CognitiveServices/dataPlane/Personalizer/Generated + sync-methods: all + clear-output-folder: true +``` \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/QnAMaker/readme.ruby.md b/specification/cognitiveservices/data-plane/QnAMaker/readme.ruby.md index 235b78174402..9466e290b772 100644 --- a/specification/cognitiveservices/data-plane/QnAMaker/readme.ruby.md +++ b/specification/cognitiveservices/data-plane/QnAMaker/readme.ruby.md @@ -21,6 +21,6 @@ These settings apply only when `--tag=release_4_0 --ruby` is specified on the co Please also specify `--ruby-sdks-folder=`. ``` yaml $(tag) == 'release_4_0' && $(ruby) -namespace: "Azure::CognitiveServices::QnAMaker::V4" +namespace: "Azure::CognitiveServices::Qnamaker::V4_0" output-folder: $(ruby-sdks-folder)/data/azure_cognitiveservices_qnamaker/lib ``` \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/QnAMaker/stable/v4.0/QnAMaker.json b/specification/cognitiveservices/data-plane/QnAMaker/stable/v4.0/QnAMaker.json index 90cc08585a4d..8c3ab959512d 100644 --- a/specification/cognitiveservices/data-plane/QnAMaker/stable/v4.0/QnAMaker.json +++ b/specification/cognitiveservices/data-plane/QnAMaker/stable/v4.0/QnAMaker.json @@ -622,6 +622,14 @@ "$ref": "#/definitions/UpdateMetadataDTO" } ] + }, + "context": { + "description": "Context associated with Qna to be updated.", + "allOf": [ + { + "$ref": "#/definitions/UpdateContextDTO" + } + ] } } }, @@ -671,6 +679,31 @@ } } }, + "UpdateContextDTO": { + "type": "object", + "description": "Update Body schema to represent context to be updated", + "properties": { + "promptsToDelete": { + "type": "array", + "description": "List of prompts associated with qna to be deleted", + "items": { + "type": "integer", + "format": "int32" + } + }, + "promptsToAdd": { + "type": "array", + "description": "List of prompts to be added to the qna.", + "items": { + "$ref": "#/definitions/PromptDTO" + } + }, + "isContextOnly": { + "type": "boolean", + "description": "To mark if a prompt is relevant only with a previous question or not.\ntrue - Do not include this QnA as search result for queries without context\nfalse - ignores context and includes this QnA in search result" + } + } + }, "DeleteKbContentsDTO": { "type": "object", "description": "PATCH body schema of Delete Operation in UpdateKb", @@ -870,6 +903,61 @@ "items": { "$ref": "#/definitions/MetadataDTO" } + }, + "context": { + "description": "Context of a QnA", + "allOf": [ + { + "$ref": "#/definitions/ContextDTO" + } + ] + } + } + }, + "ContextDTO": { + "type": "object", + "description": "Context associated with Qna.", + "properties": { + "isContextOnly": { + "type": "boolean", + "description": "To mark if a prompt is relevant only with a previous question or not.\ntrue - Do not include this QnA as search result for queries without context\nfalse - ignores context and includes this QnA in search result" + }, + "prompts": { + "type": "array", + "description": "List of prompts associated with the answer.", + "maxItems": 20, + "items": { + "$ref": "#/definitions/PromptDTO" + } + } + } + }, + "PromptDTO": { + "type": "object", + "description": "Prompt for an answer.", + "properties": { + "displayOrder": { + "type": "integer", + "description": "Index of the prompt - used in ordering of the prompts", + "format": "int32" + }, + "qnaId": { + "type": "integer", + "description": "Qna id corresponding to the prompt - if QnaId is present, QnADTO object is ignored.", + "format": "int32" + }, + "qna": { + "description": "QnADTO - Either QnaId or QnADTO needs to be present in a PromptDTO object", + "allOf": [ + { + "$ref": "#/definitions/QnADTO" + } + ] + }, + "displayText": { + "type": "string", + "description": "Text displayed to represent a follow up question prompt", + "maxLength": 200 } } }, diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/compute.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/compute.json index 03fd6d129964..3326efdc955a 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/compute.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/compute.json @@ -4687,6 +4687,18 @@ }, "description": "Describes the properties of a Compute Operation Value Display." }, + "HyperVGenerationType": { + "type": "string", + "description": "Specifies the HyperVGeneration Type for the Virtual Machine created from the image", + "enum": [ + "V1", + "V2" + ], + "x-ms-enum": { + "name": "HyperVGenerationTypes", + "modelAsString": true + } + }, "InstanceViewStatus": { "properties": { "code": { @@ -5873,6 +5885,10 @@ "managedDisk": { "description": "The managed disk parameters.", "$ref": "#/definitions/ManagedDiskParameters" + }, + "toBeDetached": { + "type": "boolean", + "description": "Specifies whether the datadisk is in process of detachment from the VirtualMachine/VirtualMachineScaleset" } }, "required": [ @@ -6800,6 +6816,10 @@ "readOnly": true, "type": "string", "description": "The provisioning state." + }, + "hyperVGeneration": { + "$ref": "#/definitions/HyperVGenerationType", + "description": "Gets the HyperVGenerationType of the VirtualMachine created from the image" } }, "description": "Describes the properties of an Image." @@ -7645,10 +7665,6 @@ "$ref": "#/definitions/VirtualMachineScaleSetStorageProfile", "description": "Specifies the storage settings for the virtual machine disks." }, - "additionalCapabilities": { - "$ref": "#/definitions/AdditionalCapabilities", - "description": "Specifies additional capabilities enabled or disabled on the virtual machine in the scale set. For instance: whether the virtual machine has the capability to support attaching managed data disks with UltraSSD_LRS storage account type." - }, "networkProfile": { "$ref": "#/definitions/VirtualMachineScaleSetNetworkProfile", "description": "Specifies properties of the network interfaces of the virtual machines in the scale set." @@ -7765,6 +7781,10 @@ "proximityPlacementGroup": { "$ref": "#/definitions/SubResource", "description": "Specifies information about the proximity placement group that the virtual machine scale set should be assigned to.

Minimum api-version: 2018-04-01." + }, + "additionalCapabilities": { + "$ref": "#/definitions/AdditionalCapabilities", + "description": "Specifies additional capabilities enabled or disabled on the Virtual Machines in the Virtual Machine Scale Set. For instance: whether the Virtual Machines have the capability to support attaching managed data disks with UltraSSD_LRS storage account type." } }, "description": "Describes the properties of a Virtual Machine Scale Set." @@ -7786,6 +7806,10 @@ "singlePlacementGroup": { "type": "boolean", "description": "When true this limits the scale set to a single placement group, of max size 100 virtual machines." + }, + "additionalCapabilities": { + "$ref": "#/definitions/AdditionalCapabilities", + "description": "Specifies additional capabilities enabled or disabled on the Virtual Machines in the Virtual Machine Scale Set. For instance: whether the Virtual Machines have the capability to support attaching managed data disks with UltraSSD_LRS storage account type." } }, "description": "Describes the properties of a Virtual Machine Scale Set." diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/CreateAVmWithEmptyDataDisks.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/CreateAVmWithEmptyDataDisks.json index db4be842f254..9e5e380836c4 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/CreateAVmWithEmptyDataDisks.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/CreateAVmWithEmptyDataDisks.json @@ -177,7 +177,8 @@ }, "createOption": "Empty", "lun": 0, - "diskSizeGB": 1023 + "diskSizeGB": 1023, + "toBeDetached": false }, { "caching": "None", @@ -186,7 +187,8 @@ }, "createOption": "Empty", "lun": 1, - "diskSizeGB": 1023 + "diskSizeGB": 1023, + "toBeDetached": false } ] }, diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-04-01/skus.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-04-01/skus.json new file mode 100644 index 000000000000..b4e15eda386b --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-04-01/skus.json @@ -0,0 +1,375 @@ +{ + "swagger": "2.0", + "info": { + "title": "ComputeManagementClient", + "description": "The Compute Management Client.", + "version": "2019-04-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.Compute/skus": { + "get": { + "tags": [ + "Skus", + "AvailabilitySets" + ], + "operationId": "ResourceSkus_List", + "description": "Gets the list of Microsoft.Compute SKUs available for your Subscription.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResourceSkusResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "ResourceSkuCapacity": { + "properties": { + "minimum": { + "type": "integer", + "readOnly": true, + "format": "int64", + "description": "The minimum capacity." + }, + "maximum": { + "type": "integer", + "readOnly": true, + "format": "int64", + "description": "The maximum capacity that can be set." + }, + "default": { + "type": "integer", + "readOnly": true, + "format": "int64", + "description": "The default capacity." + }, + "scaleType": { + "type": "string", + "readOnly": true, + "description": "The scale type applicable to the sku.", + "enum": [ + "Automatic", + "Manual", + "None" + ], + "x-ms-enum": { + "name": "ResourceSkuCapacityScaleType", + "modelAsString": false + } + } + }, + "description": "Describes scaling information of a SKU." + }, + "ResourceSkuCosts": { + "properties": { + "meterID": { + "type": "string", + "readOnly": true, + "description": "Used for querying price from commerce." + }, + "quantity": { + "type": "integer", + "readOnly": true, + "format": "int64", + "description": "The multiplier is needed to extend the base metered cost." + }, + "extendedUnit": { + "type": "string", + "readOnly": true, + "description": "An invariant to show the extended unit." + } + }, + "description": "Describes metadata for retrieving price info." + }, + "ResourceSkuCapabilities": { + "properties": { + "name": { + "type": "string", + "readOnly": true, + "description": "An invariant to describe the feature." + }, + "value": { + "type": "string", + "readOnly": true, + "description": "An invariant if the feature is measured by quantity." + } + }, + "description": "Describes The SKU capabilities object." + }, + "ResourceSkuZoneDetails": { + "properties": { + "name": { + "type": "array", + "readOnly": true, + "items": { + "type": "string" + }, + "description": "The set of zones that the SKU is available in with the specified capabilities." + }, + "capabilities": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/ResourceSkuCapabilities" + }, + "description": "A list of capabilities that are available for the SKU in the specified list of zones." + } + }, + "description": "Describes The zonal capabilities of a SKU." + }, + "ResourceSkuRestrictions": { + "properties": { + "type": { + "type": "string", + "readOnly": true, + "description": "The type of restrictions.", + "enum": [ + "Location", + "Zone" + ], + "x-ms-enum": { + "name": "ResourceSkuRestrictionsType", + "modelAsString": false + } + }, + "values": { + "type": "array", + "readOnly": true, + "items": { + "type": "string" + }, + "description": "The value of restrictions. If the restriction type is set to location. This would be different locations where the SKU is restricted." + }, + "restrictionInfo": { + "$ref": "#/definitions/ResourceSkuRestrictionInfo", + "readOnly": true, + "description": "The information about the restriction where the SKU cannot be used." + }, + "reasonCode": { + "type": "string", + "readOnly": true, + "description": "The reason for restriction.", + "enum": [ + "QuotaId", + "NotAvailableForSubscription" + ], + "x-ms-enum": { + "name": "ResourceSkuRestrictionsReasonCode", + "modelAsString": false + } + } + }, + "description": "Describes scaling information of a SKU." + }, + "ResourceSku": { + "properties": { + "resourceType": { + "readOnly": true, + "type": "string", + "description": "The type of resource the SKU applies to." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of SKU." + }, + "tier": { + "readOnly": true, + "type": "string", + "description": "Specifies the tier of virtual machines in a scale set.

Possible Values:

**Standard**

**Basic**" + }, + "size": { + "readOnly": true, + "type": "string", + "description": "The Size of the SKU." + }, + "family": { + "readOnly": true, + "type": "string", + "description": "The Family of this particular SKU." + }, + "kind": { + "readOnly": true, + "type": "string", + "description": "The Kind of resources that are supported in this SKU." + }, + "capacity": { + "$ref": "#/definitions/ResourceSkuCapacity", + "readOnly": true, + "description": "Specifies the number of virtual machines in the scale set." + }, + "locations": { + "type": "array", + "readOnly": true, + "items": { + "type": "string" + }, + "description": "The set of locations that the SKU is available." + }, + "locationInfo": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/ResourceSkuLocationInfo" + }, + "description": "A list of locations and availability zones in those locations where the SKU is available." + }, + "apiVersions": { + "type": "array", + "readOnly": true, + "items": { + "type": "string" + }, + "description": "The api versions that support this SKU." + }, + "costs": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/ResourceSkuCosts" + }, + "description": "Metadata for retrieving price info." + }, + "capabilities": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/ResourceSkuCapabilities" + }, + "description": "A name value pair to describe the capability." + }, + "restrictions": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/ResourceSkuRestrictions" + }, + "description": "The restrictions because of which SKU cannot be used. This is empty if there are no restrictions." + } + }, + "description": "Describes an available Compute SKU." + }, + "ResourceSkuLocationInfo": { + "properties": { + "location": { + "readOnly": true, + "type": "string", + "description": "Location of the SKU" + }, + "zones": { + "readOnly": true, + "type": "array", + "items": { + "type": "string" + }, + "description": "List of availability zones where the SKU is supported." + }, + "zoneDetails": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/ResourceSkuZoneDetails" + }, + "description": "Details of capabilities available to a SKU in specific zones." + } + } + }, + "ResourceSkuRestrictionInfo": { + "properties": { + "locations": { + "readOnly": true, + "type": "array", + "items": { + "type": "string" + }, + "description": "Locations where the SKU is restricted" + }, + "zones": { + "readOnly": true, + "type": "array", + "items": { + "type": "string" + }, + "description": "List of availability zones where the SKU is restricted." + } + } + }, + "ResourceSkusResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceSku" + }, + "description": "The list of skus available for the subscription." + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of Compute Skus. Call ListNext() with this to fetch the next page of VMSS Skus." + } + }, + "required": [ + "value" + ], + "description": "The Compute List Skus operation response." + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client Api Version." + } + } +} \ No newline at end of file diff --git a/specification/compute/resource-manager/readme.csharp.md b/specification/compute/resource-manager/readme.csharp.md index f853685c57aa..ba0564dc40b2 100644 --- a/specification/compute/resource-manager/readme.csharp.md +++ b/specification/compute/resource-manager/readme.csharp.md @@ -37,6 +37,11 @@ batch: ApiVersionName: Api2016_03_30 ``` + +### Profile: hybrid_2018_03_01 + +These settings apply only when `--profile=hybrid_2018_03_01` is specified on the command line. + ```yaml $(profile)=='hybrid_2018_03_01' namespace: Microsoft.Azure.Management.Profiles.$(profile).Compute output-folder: $(csharp-sdks-folder)/$(profile)/Compute/Management.Compute/Generated @@ -47,6 +52,10 @@ batch: - tag: package-compute-2017-03 ``` +### Profile: profile_2017_03_09 + +These settings apply only when `--profile=profile_2017_03_09` is specified on the command line. + ``` yaml $(profile)=='profile_2017_03_09' namespace: Microsoft.Azure.Management.Profiles.$(profile).Compute output-folder: $(csharp-sdks-folder)/$(profile)/Compute/Management.Compute/Generated diff --git a/specification/compute/resource-manager/readme.md b/specification/compute/resource-manager/readme.md index e98e35585694..fcb334047cb2 100644 --- a/specification/compute/resource-manager/readme.md +++ b/specification/compute/resource-manager/readme.md @@ -197,12 +197,21 @@ These settings apply only when `--tag=package-2019-03-01` is specified on the co input-file: - Microsoft.Compute/stable/2019-03-01/compute.json - Microsoft.Compute/stable/2019-03-01/runCommands.json -- Microsoft.Compute/stable/2017-09-01/skus.json +- Microsoft.Compute/stable/2019-04-01/skus.json - Microsoft.Compute/stable/2018-09-30/disk.json - Microsoft.Compute/stable/2019-03-01/gallery.json - Microsoft.ContainerService/stable/2017-01-31/containerService.json ``` +### Tag: package-2019-04-01-only + +These settings apply only when `--tag=package-2019-04-01-only` is specified on the command line. + +``` yaml $(tag) == 'package-2019-04-01-only' +input-file: +- Microsoft.Compute/stable/2019-04-01/skus.json +``` + ### Tag: package-2019-03-01-only These settings apply only when `--tag=package-2019-03-01-only` is specified on the command line. diff --git a/specification/compute/resource-manager/readme.python.md b/specification/compute/resource-manager/readme.python.md index 013318acce25..284105fb65b7 100644 --- a/specification/compute/resource-manager/readme.python.md +++ b/specification/compute/resource-manager/readme.python.md @@ -18,6 +18,7 @@ Generate all API versions currently shipped for this package ```yaml $(python) && $(multiapi) batch: + - tag: package-2019-04-01-only - tag: package-2019-03-01-only - tag: package-2018-10-01-only - tag: package-2018-09-30-only @@ -31,6 +32,17 @@ batch: - tag: package-compute-2015-06 ``` +### Tag: package-2019-04-01-only and python + +These settings apply only when `--tag=package-2019-04-01-only --python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +``` yaml $(tag) == 'package-2019-04-01-only' && $(python) +python: + namespace: azure.mgmt.compute.v2019_04_01 + output-folder: $(python-sdks-folder)/azure-mgmt-compute/azure/mgmt/compute/v2019_04_01 +``` + ### Tag: package-2019-03-01-only and python These settings apply only when `--tag=package-2019-03-01-only --python` is specified on the command line. diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2018-02-01-preview/examples/BuildStepsCreate.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2018-02-01-preview/examples/BuildStepsCreate.json index 972e21e9a3bc..855f7b90ced0 100644 --- a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2018-02-01-preview/examples/BuildStepsCreate.json +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2018-02-01-preview/examples/BuildStepsCreate.json @@ -12,8 +12,8 @@ "imageNames": [ "azurerest:testtag" ], - "dockerFilePath": "src/DockerFile", - "contextPath": "src", + "dockerFilePath": "subfolder/Dockerfile", + "contextPath": "dockerfiles", "isPushEnabled": true, "noCache": true, "buildArguments": [ @@ -42,8 +42,8 @@ "imageNames": [ "azurerest:testtag" ], - "dockerFilePath": "src/DockerFile", - "contextPath": "src", + "dockerFilePath": "subfolder/Dockerfile", + "contextPath": "dockerfiles", "isPushEnabled": true, "noCache": false, "provisioningState": "Succeeded", @@ -76,8 +76,8 @@ "imageNames": [ "azurerest:testtag" ], - "dockerFilePath": "src/DockerFile", - "contextPath": "src", + "dockerFilePath": "subfolder/Dockerfile", + "contextPath": "dockerfiles", "isPushEnabled": true, "noCache": false, "provisioningState": "Updating", diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2018-02-01-preview/examples/BuildStepsGet.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2018-02-01-preview/examples/BuildStepsGet.json index b594955b6e51..afe24775a3ea 100644 --- a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2018-02-01-preview/examples/BuildStepsGet.json +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2018-02-01-preview/examples/BuildStepsGet.json @@ -16,8 +16,8 @@ "imageNames": [ "azurerest:testtag" ], - "dockerFilePath": "src/DockerFile", - "contextPath": "src", + "dockerFilePath": "subfolder/Dockerfile", + "contextPath": "dockerfiles", "isPushEnabled": true, "noCache": false, "provisioningState": "Succeeded", diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2018-02-01-preview/examples/BuildStepsList.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2018-02-01-preview/examples/BuildStepsList.json index 5f1d968c675e..ffa0252f1775 100644 --- a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2018-02-01-preview/examples/BuildStepsList.json +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2018-02-01-preview/examples/BuildStepsList.json @@ -17,8 +17,8 @@ "imageNames": [ "azurerest:testtag" ], - "dockerFilePath": "src/DockerFile", - "contextPath": "src", + "dockerFilePath": "subfolder/Dockerfile", + "contextPath": "dockerfiles", "isPushEnabled": true, "noCache": false, "provisioningState": "Succeeded", diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2018-02-01-preview/examples/BuildStepsUpdate.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2018-02-01-preview/examples/BuildStepsUpdate.json index 6e224805686d..db2a96de3730 100644 --- a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2018-02-01-preview/examples/BuildStepsUpdate.json +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2018-02-01-preview/examples/BuildStepsUpdate.json @@ -13,8 +13,8 @@ "azurerest:testtag", "azurerest1:testtag1" ], - "dockerFilePath": "src/DockerFile", - "contextPath": "src", + "dockerFilePath": "subfolder/Dockerfile", + "contextPath": "dockerfiles", "isPushEnabled": true, "noCache": false, "baseImageTrigger": "None", @@ -44,8 +44,8 @@ "imageNames": [ "azurerest:testtag" ], - "dockerFilePath": "src/DockerFile", - "contextPath": "src", + "dockerFilePath": "subfolder/Dockerfile", + "contextPath": "dockerfiles", "isPushEnabled": true, "noCache": false, "provisioningState": "Succeeded", @@ -78,8 +78,8 @@ "imageNames": [ "azurerest:testtag" ], - "dockerFilePath": "src/DockerFile", - "contextPath": "src", + "dockerFilePath": "subfolder/Dockerfile", + "contextPath": "dockerfiles", "isPushEnabled": true, "noCache": false, "provisioningState": "Updating", diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2018-02-01-preview/examples/RegistriesQueueBuild.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2018-02-01-preview/examples/RegistriesQueueBuild.json index a94ab9c28500..bbe7338d97a9 100644 --- a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2018-02-01-preview/examples/RegistriesQueueBuild.json +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2018-02-01-preview/examples/RegistriesQueueBuild.json @@ -30,7 +30,7 @@ "osType": "Linux", "cpu": 2 }, - "dockerFilePath": "DockerFile" + "dockerFilePath": "subfolder/Dockerfile" } }, "responses": { diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2018-09-01/containerregistry_build.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2018-09-01/containerregistry_build.json index 332fff7c3d86..9f4c93caf957 100644 --- a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2018-09-01/containerregistry_build.json +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2018-09-01/containerregistry_build.json @@ -64,6 +64,21 @@ "x-ms-examples": { "Registries_ScheduleRun": { "$ref": "./examples/RegistriesScheduleRun.json" + }, + "Registries_ScheduleRun_EncodedTaskRun": { + "$ref": "./examples/RegistriesScheduleRun_EncodedTaskRun.json" + }, + "Registries_ScheduleRun_FileTaskRun": { + "$ref": "./examples/RegistriesScheduleRun_FileTaskRun.json" + }, + "Registries_ScheduleRun_Task": { + "$ref": "./examples/RegistriesScheduleRun_Task.json" + }, + "Registries_ScheduleRun_Task_WithCustomCredentials": { + "$ref": "./examples/RegistriesScheduleRun_FileTask_WithCustomCredentials.json" + }, + "Registries_ScheduleRun_WithCustomCredentials": { + "$ref": "./examples/RegistriesScheduleRun_WithCustomCredentials.json" } } } diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2018-09-01/examples/RegistriesScheduleRun.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2018-09-01/examples/RegistriesScheduleRun.json index 224d6286f162..89aa3b808226 100644 --- a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2018-09-01/examples/RegistriesScheduleRun.json +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2018-09-01/examples/RegistriesScheduleRun.json @@ -32,7 +32,7 @@ "agentConfiguration": { "cpu": 2 }, - "dockerFilePath": "DockerFile" + "dockerFilePath": "subfolder/Dockerfile" } }, "responses": { diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2018-09-01/examples/RegistriesScheduleRun_EncodedTaskRun.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2018-09-01/examples/RegistriesScheduleRun_EncodedTaskRun.json index beb63ea9c8a0..15c95951d943 100644 --- a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2018-09-01/examples/RegistriesScheduleRun_EncodedTaskRun.json +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2018-09-01/examples/RegistriesScheduleRun_EncodedTaskRun.json @@ -25,7 +25,7 @@ "cpu": 2 }, "encodedTaskContent": "c3RlcHM6Cnt7IGlmIFZhbHVlcy5lbnZpcm9ubWVudCA9PSAncHJvZCcgfX0KICAtIHJ1bjogcHJvZCBzZXR1cAp7eyBlbHNlIGlmIFZhbHVlcy5lbnZpcm9ubWVudCA9PSAnc3RhZ2luZycgfX0KICAtIHJ1bjogc3RhZ2luZyBzZXR1cAp7eyBlbHNlIH19CiAgLSBydW46IGRlZmF1bHQgc2V0dXAKe3sgZW5kIH19CgogIC0gcnVuOiBidWlsZCAtdCBGYW5jeVRoaW5nOnt7LlZhbHVlcy5lbnZpcm9ubWVudH19LXt7LlZhbHVlcy52ZXJzaW9ufX0gLgoKcHVzaDogWydGYW5jeVRoaW5nOnt7LlZhbHVlcy5lbnZpcm9ubWVudH19LXt7LlZhbHVlcy52ZXJzaW9ufX0nXQ==", - "encodedValuesContent":"ZW52aXJvbm1lbnQ6IHByb2QKdmVyc2lvbjogMQ==" + "encodedValuesContent": "ZW52aXJvbm1lbnQ6IHByb2QKdmVyc2lvbjogMQ==" } }, "responses": { diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2018-09-01/examples/RegistriesScheduleRun_Task_WithCustomCredentials.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2018-09-01/examples/RegistriesScheduleRun_FileTask_WithCustomCredentials.json similarity index 75% rename from specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2018-09-01/examples/RegistriesScheduleRun_Task_WithCustomCredentials.json rename to specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2018-09-01/examples/RegistriesScheduleRun_FileTask_WithCustomCredentials.json index 4eafc8ac646d..6afb88615fc3 100644 --- a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2018-09-01/examples/RegistriesScheduleRun_Task_WithCustomCredentials.json +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2018-09-01/examples/RegistriesScheduleRun_FileTask_WithCustomCredentials.json @@ -5,7 +5,7 @@ "registryName": "myRegistry", "api-version": "2018-09-01", "runRequest": { - "type": "TaskRunRequest", + "type": "FileTaskRunRequest", "values": [ { "name": "mytestargument", @@ -18,24 +18,27 @@ "isSecret": true } ], - "taskName": "myTask", + "platform": { + "os": "Linux" + }, + "taskFilePath": "acb.yaml", "credentials": { "sourceRegistry": { - "loginMode": "Default" + "loginMode": "Default" }, "customRegistries": { - "myregistry.azurecr.io": { - "userName": { - "type": "Opaque", - "value": "reg1" - }, - "password": { - "type": "Opaque", - "value": "***" - } + "myregistry.azurecr.io": { + "userName": { + "type": "Opaque", + "value": "reg1" + }, + "password": { + "type": "Opaque", + "value": "***" } + } } - } + } } }, "responses": { diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2018-09-01/examples/RegistriesScheduleRun_WithCustomCredentials.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2018-09-01/examples/RegistriesScheduleRun_WithCustomCredentials.json index ecd8d6c3b889..e7fa51ad99b8 100644 --- a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2018-09-01/examples/RegistriesScheduleRun_WithCustomCredentials.json +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2018-09-01/examples/RegistriesScheduleRun_WithCustomCredentials.json @@ -41,22 +41,22 @@ "customRegistries": { "myregistry.azurecr.io": { "userName": { - "Type": "Opaque", - "Value": "reg1" + "type": "Opaque", + "value": "reg1" }, "password": { - "Type": "Opaque", - "Value": "***" + "type": "Opaque", + "value": "***" } }, "myregistry2.azurecr.io": { "userName": { - "Type": "Opaque", - "Value": "reg2" + "type": "Opaque", + "value": "reg2" }, "password": { - "Type": "Opaque", - "Value": "***" + "type": "Opaque", + "value": "***" } } } diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2018-09-01/examples/TasksCreate.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2018-09-01/examples/TasksCreate.json index d910b6b12608..c9936a150efe 100644 --- a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2018-09-01/examples/TasksCreate.json +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2018-09-01/examples/TasksCreate.json @@ -20,8 +20,8 @@ "imageNames": [ "azurerest:testtag" ], - "dockerFilePath": "src/DockerFile", - "contextPath": "src", + "dockerFilePath": "subfolder/Dockerfile", + "contextPath": "dockerfiles", "isPushEnabled": true, "noCache": false, "arguments": [ @@ -52,7 +52,8 @@ }, "sourceTriggerEvents":[ "commit" - ] + ], + "status": "Enabled" } ], "baseImageTrigger": { @@ -86,8 +87,8 @@ "imageNames": [ "azurerest:testtag" ], - "dockerFilePath": "src/DockerFile", - "contextPath": "src", + "dockerFilePath": "subfolder/Dockerfile", + "contextPath": "dockerfiles", "isPushEnabled": true, "noCache": false, "arguments": [ @@ -109,7 +110,8 @@ }, "sourceTriggerEvents":[ "commit" - ] + ], + "status": "Enabled" } ], "baseImageTrigger": { @@ -145,8 +147,8 @@ "imageNames": [ "azurerest:testtag" ], - "dockerFilePath": "src/DockerFile", - "contextPath": "src", + "dockerFilePath": "subfolder/Dockerfile", + "contextPath": "dockerfiles", "isPushEnabled": true, "noCache": false, "arguments": [ @@ -168,7 +170,8 @@ }, "sourceTriggerEvents":[ "commit" - ] + ], + "status": "Enabled" } ], "baseImageTrigger": { diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2018-09-01/examples/TasksGet.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2018-09-01/examples/TasksGet.json index b3a57c896a14..6436a7d49d4a 100644 --- a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2018-09-01/examples/TasksGet.json +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2018-09-01/examples/TasksGet.json @@ -25,8 +25,8 @@ "imageNames": [ "azurerest:testtag" ], - "dockerFilePath": "src/DockerFile", - "contextPath": "src", + "dockerFilePath": "subfolder/Dockerfile", + "contextPath": "dockerfiles", "isPushEnabled": true, "noCache": false, "arguments": [ @@ -48,7 +48,8 @@ }, "sourceTriggerEvents":[ "commit" - ] + ], + "status": "Enabled" } ], "baseImageTrigger": { diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2018-09-01/examples/TasksGetDetails.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2018-09-01/examples/TasksGetDetails.json index 2cf8941b7d58..a10e2ebd03f1 100644 --- a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2018-09-01/examples/TasksGetDetails.json +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2018-09-01/examples/TasksGetDetails.json @@ -23,8 +23,8 @@ "imageNames": [ "azurerest:testtag" ], - "dockerFilePath": "src/DockerFile", - "contextPath": "src", + "dockerFilePath": "subfolder/Dockerfile", + "contextPath": "dockerfiles", "isPushEnabled": true, "noCache": false, "arguments": [ @@ -55,7 +55,8 @@ }, "sourceTriggerEvents":[ "commit" - ] + ], + "status": "Enabled" } ], "baseImageTrigger": { diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2018-09-01/examples/TasksList.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2018-09-01/examples/TasksList.json index 8fdc3da5cb69..b5bf0b264a5f 100644 --- a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2018-09-01/examples/TasksList.json +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2018-09-01/examples/TasksList.json @@ -26,8 +26,8 @@ "imageNames": [ "azurerest:testtag" ], - "dockerFilePath": "src/DockerFile", - "contextPath": "src", + "dockerFilePath": "subfolder/Dockerfile", + "contextPath": "dockerfiles", "isPushEnabled": true, "noCache": false, "arguments": [ @@ -49,7 +49,8 @@ }, "sourceTriggerEvents":[ "commit" - ] + ], + "status": "Enabled" } ], "baseImageTrigger": { diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2018-09-01/examples/TasksUpdate.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2018-09-01/examples/TasksUpdate.json index f85dbf5b969a..6aadf4f79173 100644 --- a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2018-09-01/examples/TasksUpdate.json +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2018-09-01/examples/TasksUpdate.json @@ -16,8 +16,8 @@ "imageNames": [ "azurerest:testtag1" ], - "dockerFilePath": "src/DockerFile" - }, + "dockerFilePath": "subfolder/Dockerfile" + }, "trigger":{ "sourceTriggers": [ { @@ -30,7 +30,8 @@ }, "sourceTriggerEvents":[ "commit" - ] + ], + "status": "Enabled" } ] } @@ -59,8 +60,8 @@ "imageNames": [ "azurerest:testtag1" ], - "dockerFilePath": "src/DockerFile", - "contextPath": "src", + "dockerFilePath": "subfolder/Dockerfile", + "contextPath": "dockerfiles", "isPushEnabled": true, "noCache": false, "arguments": [ @@ -82,7 +83,8 @@ }, "sourceTriggerEvents":[ "commit" - ] + ], + "status": "Enabled" } ], "baseImageTrigger": { @@ -118,8 +120,8 @@ "imageNames": [ "azurerest:testtag1" ], - "dockerFilePath": "src/DockerFile", - "contextPath": "src", + "dockerFilePath": "subfolder/Dockerfile", + "contextPath": "dockerfiles", "isPushEnabled": true, "noCache": false, "arguments": [ @@ -141,7 +143,8 @@ }, "sourceTriggerEvents":[ "commit" - ] + ], + "status": "Enabled" } ], "baseImageTrigger": { diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2019-04-01/containerregistry_build.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2019-04-01/containerregistry_build.json new file mode 100644 index 000000000000..e3ce011b0da1 --- /dev/null +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2019-04-01/containerregistry_build.json @@ -0,0 +1,2539 @@ +{ + "swagger": "2.0", + "info": { + "version": "2019-04-01", + "title": "ContainerRegistryManagementClient" + }, + "host": "management.azure.com", + "basePath": "/", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/scheduleRun": { + "post": { + "tags": [ + "Registries" + ], + "description": "Schedules a new run based on the request parameters and add it to the run queue.", + "operationId": "Registries_ScheduleRun", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/RegistryNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "runRequest", + "in": "body", + "description": "The parameters of a run that needs to scheduled.", + "required": true, + "schema": { + "$ref": "#/definitions/RunRequest" + } + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/Run" + } + }, + "202": { + "description": "The request was successfully accepted; the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed. If the registry/run doesn't exist, 404 (Not found) is returned. If any of the input parameters is wrong, 400(Bad Request) is returned." + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Registries_ScheduleRun": { + "$ref": "./examples/RegistriesScheduleRun.json" + }, + "Registries_ScheduleRun_EncodedTaskRun": { + "$ref": "./examples/RegistriesScheduleRun_EncodedTaskRun.json" + }, + "Registries_ScheduleRun_FileTaskRun": { + "$ref": "./examples/RegistriesScheduleRun_FileTaskRun.json" + }, + "Registries_ScheduleRun_Task": { + "$ref": "./examples/RegistriesScheduleRun_Task.json" + }, + "Registries_ScheduleRun_Task_WithCustomCredentials": { + "$ref": "./examples/RegistriesScheduleRun_FileTask_WithCustomCredentials.json" + }, + "Registries_ScheduleRun_WithCustomCredentials": { + "$ref": "./examples/RegistriesScheduleRun_WithCustomCredentials.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/listBuildSourceUploadUrl": { + "post": { + "tags": [ + "Registries" + ], + "description": "Get the upload location for the user to be able to upload the source.", + "operationId": "Registries_GetBuildSourceUploadUrl", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/RegistryNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/SourceUploadDefinition" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the registry doesn't exist, 404 (Not found) is returned." + } + }, + "x-ms-examples": { + "Registries_GetBuildSourceUploadUrl": { + "$ref": "./examples/RegistriesGetBuildSourceUploadUrl.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/runs": { + "get": { + "tags": [ + "Runs" + ], + "description": "Gets all the runs for a registry.", + "operationId": "Runs_List", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/RegistryNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "$filter", + "in": "query", + "description": "The runs filter to apply on the operation. Arithmetic operators are not supported. The allowed string function is 'contains'. All logical operators except 'Not', 'Has', 'All' are allowed.", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "$top is supported for get list of runs, which limits the maximum number of runs to return.", + "required": false, + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/RunListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed." + } + }, + "x-ms-odata": "#/definitions/RunFilter", + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Runs_List": { + "$ref": "./examples/RunsList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/runs/{runId}": { + "get": { + "tags": [ + "Runs" + ], + "description": "Gets the detailed information for a given run.", + "operationId": "Runs_Get", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/RegistryNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "runId", + "in": "path", + "description": "The run ID.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/Run" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the registry/run doesn't exist, 404 (Not found) is returned." + } + }, + "x-ms-examples": { + "Runs_Get": { + "$ref": "./examples/RunsGet.json" + } + } + }, + "patch": { + "tags": [ + "Runs" + ], + "description": "Patch the run properties.", + "operationId": "Runs_Update", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/RegistryNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "runId", + "in": "path", + "description": "The run ID.", + "required": true, + "type": "string" + }, + { + "name": "runUpdateParameters", + "in": "body", + "description": "The run update properties.", + "required": true, + "schema": { + "$ref": "#/definitions/RunUpdateParameters" + } + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/Run" + } + }, + "201": { + "description": "The request was successfully accepted; the operation will complete asynchronously. The provisioning state of the resource should indicate the current state of the resource.", + "schema": { + "$ref": "#/definitions/Run" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the registry/build doesn't exist, 404 (Not found) is returned. If any of the input parameters is wrong, 400(Bad Request) is returned." + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Runs_Update": { + "$ref": "./examples/RunsUpdate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/runs/{runId}/listLogSasUrl": { + "post": { + "tags": [ + "Runs" + ], + "description": "Gets a link to download the run logs.", + "operationId": "Runs_GetLogSasUrl", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/RegistryNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "runId", + "in": "path", + "description": "The run ID.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/RunGetLogResult" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the registry/run doesn't exist, 404 (Not found) is returned." + } + }, + "x-ms-examples": { + "Runs_GetLogSasUrl": { + "$ref": "./examples/RunsGetLogSasUrl.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/runs/{runId}/cancel": { + "post": { + "tags": [ + "Runs" + ], + "description": "Cancel an existing run.", + "operationId": "Runs_Cancel", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/RegistryNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "runId", + "in": "path", + "description": "The run ID.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly." + }, + "202": { + "description": "The request was successfully accepted; the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed. If the registry/run doesn't exist, 404 (Not found) is returned." + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Runs_Cancel": { + "$ref": "./examples/RunsCancel.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/tasks": { + "get": { + "tags": [ + "Tasks" + ], + "description": "Lists all the tasks for a specified container registry.", + "operationId": "Tasks_List", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/RegistryNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/TaskListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed." + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Tasks_List": { + "$ref": "./examples/TasksList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/tasks/{taskName}": { + "get": { + "tags": [ + "Tasks" + ], + "description": "Get the properties of a specified task.", + "operationId": "Tasks_Get", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/RegistryNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/TaskNameParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/Task" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the registry doesn't exist, 404 (Not found) is returned." + } + }, + "x-ms-examples": { + "Tasks_Get": { + "$ref": "./examples/TasksGet.json" + } + } + }, + "put": { + "tags": [ + "Tasks" + ], + "description": "Creates a task for a container registry with the specified parameters.", + "operationId": "Tasks_Create", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/RegistryNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/TaskNameParameter" + }, + { + "name": "taskCreateParameters", + "in": "body", + "description": "The parameters for creating a task.", + "required": true, + "schema": { + "$ref": "#/definitions/Task" + } + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/Task" + } + }, + "201": { + "description": "The request was successfully accepted; the operation will complete asynchronously. The provisioning state of the resource should indicate the current state of the resource.", + "schema": { + "$ref": "#/definitions/Task" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the registry doesn't exist, 404 (Not found) is returned. If any of the input parameters is wrong, 400(Bad Request) is returned." + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Tasks_Create": { + "$ref": "./examples/TasksCreate.json" + }, + "Tasks_Create_WithSystemAndUserIdentities": { + "$ref": "./examples/ManagedIdentity/TasksCreate_WithSystemAndUserIdentities.json" + }, + "Tasks_Create_WithUserIdentities_WithSystemIdentity": { + "$ref": "./examples/ManagedIdentity/TasksCreate_WithSystemIdentity.json" + }, + "Tasks_Create_WithUserIdentities": { + "$ref": "./examples/ManagedIdentity/TasksCreate_WithUserIdentities.json" + } + } + }, + "delete": { + "tags": [ + "Tasks" + ], + "description": "Deletes a specified task.", + "operationId": "Tasks_Delete", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/RegistryNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/TaskNameParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly." + }, + "202": { + "description": "The request was successfully accepted; the operation will complete asynchronously." + }, + "204": { + "description": "No Content - the specified resource was not found." + }, + "default": { + "description": "Error response describing why the operation failed." + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Tasks_Delete": { + "$ref": "./examples/TasksDelete.json" + } + } + }, + "patch": { + "tags": [ + "Tasks" + ], + "description": "Updates a task with the specified parameters.", + "operationId": "Tasks_Update", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/RegistryNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/TaskNameParameter" + }, + { + "name": "taskUpdateParameters", + "in": "body", + "description": "The parameters for updating a task.", + "required": true, + "schema": { + "$ref": "#/definitions/TaskUpdateParameters" + } + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/Task" + } + }, + "201": { + "description": "The request was successfully accepted; the operation will complete asynchronously. The provisioning state of the resource should indicate the current state of the resource.", + "schema": { + "$ref": "#/definitions/Task" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the registry doesn't exist, 404 (Not found) is returned. If any of the input parameters is wrong, 400(Bad Request) is returned." + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Tasks_Update": { + "$ref": "./examples/TasksUpdate.json" + }, + "Tasks_Update_WithKeyVaultCustomCredentials": { + "$ref": "./examples/ManagedIdentity/TasksUpdate_WithKeyVaultCustomCredentials.json" + }, + "Tasks_Update_WithMSICustomCredentials": { + "$ref": "./examples/ManagedIdentity/TasksUpdate_WithMSICustomCredentials.json" + }, + "Tasks_Update_WithOpaqueCustomCredentials": { + "$ref": "./examples/TasksUpdate_WithOpaqueCustomCredentials.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/tasks/{taskName}/listDetails": { + "post": { + "tags": [ + "Tasks" + ], + "description": "Returns a task with extended information that includes all secrets.", + "operationId": "Tasks_GetDetails", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/RegistryNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/TaskNameParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/Task" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the registry doesn't exist, 404 (Not found) is returned." + } + }, + "x-ms-examples": { + "Tasks_GetDetails": { + "$ref": "./examples/TasksGetDetails.json" + } + } + } + } + }, + "definitions": { + "RunRequest": { + "description": "The request parameters for scheduling a run.", + "type": "object", + "properties": { + "type": { + "description": "The type of the run request.", + "type": "string", + "readOnly": true + }, + "isArchiveEnabled": { + "description": "The value that indicates whether archiving is enabled for the run or not.", + "default": false, + "type": "boolean" + } + }, + "discriminator": "type" + }, + "Run": { + "description": "Run resource properties", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/RunProperties", + "description": "The properties of a run.", + "x-ms-client-flatten": true + } + } + }, + "RunProperties": { + "description": "The properties for a run.", + "type": "object", + "properties": { + "runId": { + "description": "The unique identifier for the run.", + "type": "string" + }, + "status": { + "description": "The current status of the run.", + "enum": [ + "Queued", + "Started", + "Running", + "Succeeded", + "Failed", + "Canceled", + "Error", + "Timeout" + ], + "type": "string", + "x-ms-enum": { + "name": "RunStatus", + "modelAsString": true + } + }, + "lastUpdatedTime": { + "format": "date-time", + "description": "The last updated time for the run.", + "type": "string" + }, + "runType": { + "description": "The type of run.", + "enum": [ + "QuickBuild", + "QuickRun", + "AutoBuild", + "AutoRun" + ], + "type": "string", + "x-ms-enum": { + "name": "RunType", + "modelAsString": true + } + }, + "createTime": { + "format": "date-time", + "description": "The time the run was scheduled.", + "type": "string" + }, + "startTime": { + "format": "date-time", + "description": "The time the run started.", + "type": "string" + }, + "finishTime": { + "format": "date-time", + "description": "The time the run finished.", + "type": "string" + }, + "outputImages": { + "description": "The list of all images that were generated from the run. This is applicable if the run generates base image dependencies.", + "type": "array", + "items": { + "$ref": "#/definitions/ImageDescriptor" + } + }, + "task": { + "description": "The task against which run was scheduled.", + "type": "string" + }, + "imageUpdateTrigger": { + "$ref": "#/definitions/ImageUpdateTrigger", + "description": "The image update trigger that caused the run. This is applicable if the task has base image trigger configured." + }, + "sourceTrigger": { + "$ref": "#/definitions/SourceTriggerDescriptor", + "description": "The source trigger that caused the run." + }, + "platform": { + "$ref": "#/definitions/PlatformProperties", + "description": "The platform properties against which the run will happen." + }, + "agentConfiguration": { + "$ref": "#/definitions/AgentProperties", + "description": "The machine configuration of the run agent." + }, + "sourceRegistryAuth": { + "description": "The scope of the credentials that were used to login to the source registry during this run.", + "type": "string" + }, + "customRegistries": { + "description": "The list of custom registries that were logged in during this run.", + "type": "array", + "items": { + "type": "string" + } + }, + "runErrorMessage": { + "description": "The error message received from backend systems after the run is scheduled.", + "type": "string", + "readOnly": true + }, + "provisioningState": { + "description": "The provisioning state of a run.", + "enum": [ + "Creating", + "Updating", + "Deleting", + "Succeeded", + "Failed", + "Canceled" + ], + "type": "string", + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + }, + "isArchiveEnabled": { + "description": "The value that indicates whether archiving is enabled or not.", + "default": false, + "type": "boolean" + } + } + }, + "ImageDescriptor": { + "description": "Properties for a registry image.", + "type": "object", + "properties": { + "registry": { + "description": "The registry login server.", + "type": "string" + }, + "repository": { + "description": "The repository name.", + "type": "string" + }, + "tag": { + "description": "The tag name.", + "type": "string" + }, + "digest": { + "description": "The sha256-based digest of the image manifest.", + "type": "string" + } + } + }, + "ImageUpdateTrigger": { + "description": "The image update trigger that caused a build.", + "type": "object", + "properties": { + "id": { + "description": "The unique ID of the trigger.", + "type": "string" + }, + "timestamp": { + "format": "date-time", + "description": "The timestamp when the image update happened.", + "type": "string" + }, + "images": { + "description": "The list of image updates that caused the build.", + "type": "array", + "items": { + "$ref": "#/definitions/ImageDescriptor" + } + } + } + }, + "SourceTriggerDescriptor": { + "description": "The source trigger that caused a run.", + "type": "object", + "properties": { + "id": { + "description": "The unique ID of the trigger.", + "type": "string" + }, + "eventType": { + "description": "The event type of the trigger.", + "type": "string" + }, + "commitId": { + "description": "The unique ID that identifies a commit.", + "type": "string" + }, + "pullRequestId": { + "description": "The unique ID that identifies pull request.", + "type": "string" + }, + "repositoryUrl": { + "description": "The repository URL.", + "type": "string" + }, + "branchName": { + "description": "The branch name in the repository.", + "type": "string" + }, + "providerType": { + "description": "The source control provider type.", + "type": "string" + } + } + }, + "PlatformProperties": { + "description": "The platform properties against which the run has to happen.", + "required": [ + "os" + ], + "type": "object", + "properties": { + "os": { + "description": "The operating system type required for the run.", + "enum": [ + "Windows", + "Linux" + ], + "type": "string", + "x-ms-enum": { + "name": "OS", + "modelAsString": true + } + }, + "architecture": { + "description": "The OS architecture.", + "enum": [ + "amd64", + "x86", + "arm" + ], + "type": "string", + "x-ms-enum": { + "name": "Architecture", + "modelAsString": true + } + }, + "variant": { + "description": "Variant of the CPU.", + "enum": [ + "v6", + "v7", + "v8" + ], + "type": "string", + "x-ms-enum": { + "name": "Variant", + "modelAsString": true + } + } + } + }, + "AgentProperties": { + "description": "The properties that determine the run agent configuration.", + "type": "object", + "properties": { + "cpu": { + "format": "int32", + "description": "The CPU configuration in terms of number of cores required for the run.", + "type": "integer" + } + } + }, + "SourceUploadDefinition": { + "description": "The properties of a response to source upload request.", + "type": "object", + "properties": { + "uploadUrl": { + "description": "The URL where the client can upload the source.", + "type": "string" + }, + "relativePath": { + "description": "The relative path to the source. This is used to submit the subsequent queue build request.", + "type": "string" + } + } + }, + "RunListResult": { + "description": "Collection of runs.", + "type": "object", + "properties": { + "value": { + "description": "The collection value.", + "type": "array", + "items": { + "$ref": "#/definitions/Run" + } + }, + "nextLink": { + "description": "The URI that can be used to request the next set of paged results.", + "type": "string" + } + } + }, + "RunFilter": { + "description": "Properties that are enabled for Odata querying on runs.", + "type": "object", + "properties": { + "runId": { + "description": "The unique identifier for the run.", + "type": "string" + }, + "runType": { + "description": "The type of run.", + "enum": [ + "QuickBuild", + "QuickRun", + "AutoBuild", + "AutoRun" + ], + "type": "string", + "x-ms-enum": { + "name": "RunType", + "modelAsString": true + } + }, + "status": { + "description": "The current status of the run.", + "enum": [ + "Queued", + "Started", + "Running", + "Succeeded", + "Failed", + "Canceled", + "Error", + "Timeout" + ], + "type": "string", + "x-ms-enum": { + "name": "RunStatus", + "modelAsString": true + } + }, + "createTime": { + "format": "date-time", + "description": "The create time for a run.", + "type": "string" + }, + "finishTime": { + "format": "date-time", + "description": "The time the run finished.", + "type": "string" + }, + "outputImageManifests": { + "description": "The list of comma-separated image manifests that were generated from the run. This is applicable if the run is of\r\nbuild type.", + "type": "string" + }, + "isArchiveEnabled": { + "description": "The value that indicates whether archiving is enabled or not.", + "type": "boolean" + }, + "taskName": { + "description": "The name of the task that the run corresponds to.", + "type": "string" + } + } + }, + "RunUpdateParameters": { + "description": "The set of run properties that can be updated.", + "type": "object", + "properties": { + "isArchiveEnabled": { + "description": "The value that indicates whether archiving is enabled or not.", + "type": "boolean" + } + } + }, + "RunGetLogResult": { + "description": "The result of get log link operation.", + "type": "object", + "properties": { + "logLink": { + "description": "The link to logs for a run on a azure container registry.", + "type": "string" + } + } + }, + "TaskListResult": { + "description": "The collection of tasks.", + "type": "object", + "properties": { + "value": { + "description": "The collection value.", + "type": "array", + "items": { + "$ref": "#/definitions/Task" + } + }, + "nextLink": { + "description": "The URI that can be used to request the next set of paged results.", + "type": "string" + } + } + }, + "Task": { + "description": "The task that has the ARM resource and task properties. \r\nThe task will have all information to schedule a run against it.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "identity": { + "$ref": "#/definitions/IdentityProperties", + "description": "Identity for the resource." + }, + "properties": { + "$ref": "#/definitions/TaskProperties", + "description": "The properties of a task.", + "x-ms-client-flatten": true + } + } + }, + "IdentityProperties": { + "description": "Managed identity for the resource.", + "type": "object", + "properties": { + "principalId": { + "description": "The principal ID of resource identity.", + "type": "string" + }, + "tenantId": { + "description": "The tenant ID of resource.", + "type": "string" + }, + "type": { + "description": "The identity type.", + "enum": [ + "SystemAssigned", + "UserAssigned", + "SystemAssigned, UserAssigned", + "None" + ], + "type": "string", + "x-ms-enum": { + "name": "ResourceIdentityType", + "modelAsString": false + } + }, + "userAssignedIdentities": { + "description": "The list of user identities associated with the resource. The user identity \r\ndictionary key references will be ARM resource ids in the form: \r\n'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/\r\n providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/UserIdentityProperties" + } + } + } + }, + "TaskProperties": { + "description": "The properties of a task.", + "required": [ + "platform", + "step" + ], + "type": "object", + "properties": { + "provisioningState": { + "description": "The provisioning state of the task.", + "enum": [ + "Creating", + "Updating", + "Deleting", + "Succeeded", + "Failed", + "Canceled" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + }, + "creationDate": { + "format": "date-time", + "description": "The creation date of task.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "The current status of task.", + "enum": [ + "Disabled", + "Enabled" + ], + "type": "string", + "x-ms-enum": { + "name": "TaskStatus", + "modelAsString": true + } + }, + "platform": { + "$ref": "#/definitions/PlatformProperties", + "description": "The platform properties against which the run has to happen." + }, + "agentConfiguration": { + "$ref": "#/definitions/AgentProperties", + "description": "The machine configuration of the run agent." + }, + "timeout": { + "format": "int32", + "description": "Run timeout in seconds.", + "default": 3600, + "maximum": 28800, + "minimum": 300, + "type": "integer" + }, + "step": { + "$ref": "#/definitions/TaskStepProperties", + "description": "The properties of a task step." + }, + "trigger": { + "$ref": "#/definitions/TriggerProperties", + "description": "The properties that describe all triggers for the task." + }, + "credentials": { + "$ref": "#/definitions/Credentials", + "description": "The properties that describes a set of credentials that will be used when this run is invoked." + } + } + }, + "UserIdentityProperties": { + "type": "object", + "properties": { + "principalId": { + "description": "The principal id of user assigned identity.", + "type": "string" + }, + "clientId": { + "description": "The client id of user assigned identity.", + "type": "string" + } + } + }, + "TaskStepProperties": { + "description": "Base properties for any task step.", + "type": "object", + "properties": { + "type": { + "description": "The type of the step.", + "enum": [ + "Docker", + "FileTask", + "EncodedTask" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "StepType", + "modelAsString": true + } + }, + "baseImageDependencies": { + "description": "List of base image dependencies for a step.", + "type": "array", + "items": { + "$ref": "#/definitions/BaseImageDependency" + }, + "readOnly": true + }, + "contextPath": { + "description": "The URL(absolute or relative) of the source context for the task step.", + "type": "string" + }, + "contextAccessToken": { + "description": "The token (git PAT or SAS token of storage account blob) associated with the context for a step.", + "type": "string" + } + }, + "discriminator": "type" + }, + "TriggerProperties": { + "description": "The properties of a trigger.", + "type": "object", + "properties": { + "timerTriggers": { + "description": "The collection of timer triggers.", + "type": "array", + "items": { + "$ref": "#/definitions/TimerTrigger" + } + }, + "sourceTriggers": { + "description": "The collection of triggers based on source code repository.", + "type": "array", + "items": { + "$ref": "#/definitions/SourceTrigger" + } + }, + "baseImageTrigger": { + "$ref": "#/definitions/BaseImageTrigger", + "description": "The trigger based on base image dependencies." + } + } + }, + "Credentials": { + "description": "The parameters that describes a set of credentials that will be used when a run is invoked.", + "type": "object", + "properties": { + "sourceRegistry": { + "$ref": "#/definitions/SourceRegistryCredentials", + "description": "Describes the credential parameters for accessing the source registry." + }, + "customRegistries": { + "description": "Describes the credential parameters for accessing other custom registries. The key\r\nfor the dictionary item will be the registry login server (myregistry.azurecr.io) and\r\nthe value of the item will be the registry credentials for accessing the registry.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/CustomRegistryCredentials" + } + } + } + }, + "BaseImageDependency": { + "description": "Properties that describe a base image dependency.", + "type": "object", + "properties": { + "type": { + "description": "The type of the base image dependency.", + "enum": [ + "BuildTime", + "RunTime" + ], + "type": "string", + "x-ms-enum": { + "name": "BaseImageDependencyType", + "modelAsString": true + } + }, + "registry": { + "description": "The registry login server.", + "type": "string" + }, + "repository": { + "description": "The repository name.", + "type": "string" + }, + "tag": { + "description": "The tag name.", + "type": "string" + }, + "digest": { + "description": "The sha256-based digest of the image manifest.", + "type": "string" + } + } + }, + "TimerTrigger": { + "description": "The properties of a timer trigger.", + "required": [ + "schedule", + "name" + ], + "type": "object", + "properties": { + "schedule": { + "description": "The CRON expression for the task schedule", + "type": "string" + }, + "status": { + "description": "The current status of trigger.", + "default": "Enabled", + "enum": [ + "Disabled", + "Enabled" + ], + "type": "string", + "x-ms-enum": { + "name": "TriggerStatus", + "modelAsString": true + } + }, + "name": { + "description": "The name of the trigger.", + "type": "string" + } + } + }, + "SourceTrigger": { + "description": "The properties of a source based trigger.", + "required": [ + "sourceRepository", + "sourceTriggerEvents", + "name" + ], + "type": "object", + "properties": { + "sourceRepository": { + "$ref": "#/definitions/SourceProperties", + "description": "The properties that describes the source(code) for the task." + }, + "sourceTriggerEvents": { + "description": "The source event corresponding to the trigger.", + "type": "array", + "items": { + "enum": [ + "commit", + "pullrequest" + ], + "type": "string", + "x-ms-enum": { + "name": "SourceTriggerEvent", + "modelAsString": true + } + } + }, + "status": { + "description": "The current status of trigger.", + "default": "Enabled", + "enum": [ + "Disabled", + "Enabled" + ], + "type": "string", + "x-ms-enum": { + "name": "TriggerStatus", + "modelAsString": true + } + }, + "name": { + "description": "The name of the trigger.", + "type": "string" + } + } + }, + "BaseImageTrigger": { + "description": "The trigger based on base image dependency.", + "required": [ + "baseImageTriggerType", + "name" + ], + "type": "object", + "properties": { + "baseImageTriggerType": { + "description": "The type of the auto trigger for base image dependency updates.", + "enum": [ + "All", + "Runtime" + ], + "type": "string", + "x-ms-enum": { + "name": "BaseImageTriggerType", + "modelAsString": true + } + }, + "status": { + "description": "The current status of trigger.", + "default": "Enabled", + "enum": [ + "Disabled", + "Enabled" + ], + "type": "string", + "x-ms-enum": { + "name": "TriggerStatus", + "modelAsString": true + } + }, + "name": { + "description": "The name of the trigger.", + "type": "string" + } + } + }, + "SourceRegistryCredentials": { + "description": "Describes the credential parameters for accessing the source registry.", + "type": "object", + "properties": { + "loginMode": { + "description": "The authentication mode which determines the source registry login scope. The credentials for the source registry\r\nwill be generated using the given scope. These credentials will be used to login to\r\nthe source registry during the run.", + "enum": [ + "None", + "Default" + ], + "type": "string", + "x-ms-enum": { + "name": "SourceRegistryLoginMode", + "modelAsString": true + } + } + } + }, + "CustomRegistryCredentials": { + "description": "Describes the credentials that will be used to access a custom registry during a run.", + "type": "object", + "properties": { + "userName": { + "$ref": "#/definitions/SecretObject", + "description": "The username for logging into the custom registry." + }, + "password": { + "$ref": "#/definitions/SecretObject", + "description": "The password for logging into the custom registry. The password is a secret \r\nobject that allows multiple ways of providing the value for it." + }, + "identity": { + "description": "Indicates the managed identity assigned to the custom credential. If a user-assigned identity\r\nthis value is the Client ID. If a system-assigned identity, the value will be `system`. In\r\nthe case of a system-assigned identity, the Client ID will be determined by the runner. This\r\nidentity may be used to authenticate to key vault to retrieve credentials or it may be the only \r\nsource of authentication used for accessing the registry.", + "type": "string" + } + } + }, + "SourceProperties": { + "description": "The properties of the source code repository.", + "required": [ + "sourceControlType", + "repositoryUrl" + ], + "type": "object", + "properties": { + "sourceControlType": { + "description": "The type of source control service.", + "enum": [ + "Github", + "VisualStudioTeamService" + ], + "type": "string", + "x-ms-enum": { + "name": "SourceControlType", + "modelAsString": true + } + }, + "repositoryUrl": { + "description": "The full URL to the source code repository", + "type": "string" + }, + "branch": { + "description": "The branch name of the source code.", + "type": "string" + }, + "sourceControlAuthProperties": { + "$ref": "#/definitions/AuthInfo", + "description": "The authorization properties for accessing the source code repository and to set up\r\nwebhooks for notifications." + } + } + }, + "SecretObject": { + "description": "Describes the properties of a secret object value.", + "type": "object", + "properties": { + "value": { + "description": "The value of the secret. The format of this value will be determined\r\nbased on the type of the secret object. If the type is Opaque, the value will be\r\nused as is without any modification.", + "type": "string" + }, + "type": { + "description": "The type of the secret object which determines how the value of the secret object has to be\r\ninterpreted.", + "enum": [ + "Opaque", + "Vaultsecret" + ], + "type": "string", + "x-ms-enum": { + "name": "SecretObjectType", + "modelAsString": true + } + } + } + }, + "AuthInfo": { + "description": "The authorization properties for accessing the source code repository.", + "required": [ + "tokenType", + "token" + ], + "type": "object", + "properties": { + "tokenType": { + "description": "The type of Auth token.", + "enum": [ + "PAT", + "OAuth" + ], + "type": "string", + "x-ms-enum": { + "name": "TokenType", + "modelAsString": true + } + }, + "token": { + "description": "The access token used to access the source control provider.", + "type": "string" + }, + "refreshToken": { + "description": "The refresh token used to refresh the access token.", + "type": "string" + }, + "scope": { + "description": "The scope of the access token.", + "type": "string" + }, + "expiresIn": { + "format": "int32", + "description": "Time in seconds that the token remains valid", + "type": "integer" + } + } + }, + "TaskUpdateParameters": { + "description": "The parameters for updating a task.", + "type": "object", + "properties": { + "identity": { + "$ref": "#/definitions/IdentityProperties", + "description": "Identity for the resource." + }, + "properties": { + "$ref": "#/definitions/TaskPropertiesUpdateParameters", + "description": "The properties for updating a task.", + "x-ms-client-flatten": true + }, + "tags": { + "description": "The ARM resource tags.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "TaskPropertiesUpdateParameters": { + "description": "The properties for updating a task.", + "type": "object", + "properties": { + "status": { + "description": "The current status of task.", + "enum": [ + "Disabled", + "Enabled" + ], + "type": "string", + "x-ms-enum": { + "name": "TaskStatus", + "modelAsString": true + } + }, + "platform": { + "$ref": "#/definitions/PlatformUpdateParameters", + "description": "The platform properties against which the run has to happen." + }, + "agentConfiguration": { + "$ref": "#/definitions/AgentProperties", + "description": "The machine configuration of the run agent." + }, + "timeout": { + "format": "int32", + "description": "Run timeout in seconds.", + "type": "integer" + }, + "step": { + "$ref": "#/definitions/TaskStepUpdateParameters", + "description": "The properties for updating a task step." + }, + "trigger": { + "$ref": "#/definitions/TriggerUpdateParameters", + "description": "The properties for updating trigger properties." + }, + "credentials": { + "$ref": "#/definitions/Credentials", + "description": "The parameters that describes a set of credentials that will be used when this run is invoked." + } + } + }, + "PlatformUpdateParameters": { + "description": "The properties for updating the platform configuration.", + "type": "object", + "properties": { + "os": { + "description": "The operating system type required for the run.", + "enum": [ + "Windows", + "Linux" + ], + "type": "string", + "x-ms-enum": { + "name": "OS", + "modelAsString": true + } + }, + "architecture": { + "description": "The OS architecture.", + "enum": [ + "amd64", + "x86", + "arm" + ], + "type": "string", + "x-ms-enum": { + "name": "Architecture", + "modelAsString": true + } + }, + "variant": { + "description": "Variant of the CPU.", + "enum": [ + "v6", + "v7", + "v8" + ], + "type": "string", + "x-ms-enum": { + "name": "Variant", + "modelAsString": true + } + } + } + }, + "TaskStepUpdateParameters": { + "description": "Base properties for updating any task step.", + "type": "object", + "properties": { + "type": { + "description": "The type of the step.", + "enum": [ + "Docker", + "FileTask", + "EncodedTask" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "StepType", + "modelAsString": true + } + }, + "contextPath": { + "description": "The URL(absolute or relative) of the source context for the task step.", + "type": "string" + }, + "contextAccessToken": { + "description": "The token (git PAT or SAS token of storage account blob) associated with the context for a step.", + "type": "string" + } + }, + "discriminator": "type" + }, + "TriggerUpdateParameters": { + "description": "The properties for updating triggers.", + "type": "object", + "properties": { + "timerTriggers": { + "description": "The collection of timer triggers.", + "type": "array", + "items": { + "$ref": "#/definitions/TimerTriggerUpdateParameters" + } + }, + "sourceTriggers": { + "description": "The collection of triggers based on source code repository.", + "type": "array", + "items": { + "$ref": "#/definitions/SourceTriggerUpdateParameters" + } + }, + "baseImageTrigger": { + "$ref": "#/definitions/BaseImageTriggerUpdateParameters", + "description": "The trigger based on base image dependencies." + } + } + }, + "TimerTriggerUpdateParameters": { + "description": "The properties for updating a timer trigger.", + "required": [ + "name" + ], + "type": "object", + "properties": { + "schedule": { + "description": "The CRON expression for the task schedule", + "type": "string" + }, + "status": { + "description": "The current status of trigger.", + "default": "Enabled", + "enum": [ + "Disabled", + "Enabled" + ], + "type": "string", + "x-ms-enum": { + "name": "TriggerStatus", + "modelAsString": true + } + }, + "name": { + "description": "The name of the trigger.", + "type": "string" + } + } + }, + "SourceTriggerUpdateParameters": { + "description": "The properties for updating a source based trigger.", + "required": [ + "name" + ], + "type": "object", + "properties": { + "sourceRepository": { + "$ref": "#/definitions/SourceUpdateParameters", + "description": "The properties that describes the source(code) for the task." + }, + "sourceTriggerEvents": { + "description": "The source event corresponding to the trigger.", + "type": "array", + "items": { + "enum": [ + "commit", + "pullrequest" + ], + "type": "string", + "x-ms-enum": { + "name": "SourceTriggerEvent", + "modelAsString": true + } + } + }, + "status": { + "description": "The current status of trigger.", + "default": "Enabled", + "enum": [ + "Disabled", + "Enabled" + ], + "type": "string", + "x-ms-enum": { + "name": "TriggerStatus", + "modelAsString": true + } + }, + "name": { + "description": "The name of the trigger.", + "type": "string" + } + } + }, + "BaseImageTriggerUpdateParameters": { + "description": "The properties for updating base image dependency trigger.", + "required": [ + "name" + ], + "type": "object", + "properties": { + "baseImageTriggerType": { + "description": "The type of the auto trigger for base image dependency updates.", + "enum": [ + "All", + "Runtime" + ], + "type": "string", + "x-ms-enum": { + "name": "BaseImageTriggerType", + "modelAsString": true + } + }, + "status": { + "description": "The current status of trigger.", + "default": "Enabled", + "enum": [ + "Disabled", + "Enabled" + ], + "type": "string", + "x-ms-enum": { + "name": "TriggerStatus", + "modelAsString": true + } + }, + "name": { + "description": "The name of the trigger.", + "type": "string" + } + } + }, + "SourceUpdateParameters": { + "description": "The properties for updating the source code repository.", + "type": "object", + "properties": { + "sourceControlType": { + "description": "The type of source control service.", + "enum": [ + "Github", + "VisualStudioTeamService" + ], + "type": "string", + "x-ms-enum": { + "name": "SourceControlType", + "modelAsString": true + } + }, + "repositoryUrl": { + "description": "The full URL to the source code repository", + "type": "string" + }, + "branch": { + "description": "The branch name of the source code.", + "type": "string" + }, + "sourceControlAuthProperties": { + "$ref": "#/definitions/AuthInfoUpdateParameters", + "description": "The authorization properties for accessing the source code repository and to set up\r\nwebhooks for notifications." + } + } + }, + "AuthInfoUpdateParameters": { + "description": "The authorization properties for accessing the source code repository.", + "type": "object", + "properties": { + "tokenType": { + "description": "The type of Auth token.", + "enum": [ + "PAT", + "OAuth" + ], + "type": "string", + "x-ms-enum": { + "name": "TokenType", + "modelAsString": true + } + }, + "token": { + "description": "The access token used to access the source control provider.", + "type": "string" + }, + "refreshToken": { + "description": "The refresh token used to refresh the access token.", + "type": "string" + }, + "scope": { + "description": "The scope of the access token.", + "type": "string" + }, + "expiresIn": { + "format": "int32", + "description": "Time in seconds that the token remains valid", + "type": "integer" + } + } + }, + "Resource": { + "description": "An Azure resource.", + "required": [ + "location" + ], + "properties": { + "id": { + "description": "The resource ID.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The name of the resource.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "The type of the resource.", + "type": "string", + "readOnly": true + }, + "location": { + "description": "The location of the resource. This cannot be changed after the resource is created.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "tags": { + "description": "The tags of the resource.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + }, + "x-ms-azure-resource": true + }, + "ProxyResource": { + "description": "The resource model definition for a ARM proxy resource. It will have everything other than required location and tags.", + "properties": { + "id": { + "description": "The resource ID.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The name of the resource.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "The type of the resource.", + "type": "string", + "readOnly": true + } + }, + "x-ms-azure-resource": true + }, + "DockerBuildRequest": { + "description": "The parameters for a docker quick build.", + "required": [ + "type", + "dockerFilePath", + "platform" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/RunRequest" + } + ], + "properties": { + "imageNames": { + "description": "The fully qualified image names including the repository and tag.", + "type": "array", + "items": { + "type": "string" + } + }, + "isPushEnabled": { + "description": "The value of this property indicates whether the image built should be pushed to the registry or not.", + "default": true, + "type": "boolean" + }, + "noCache": { + "description": "The value of this property indicates whether the image cache is enabled or not.", + "default": false, + "type": "boolean" + }, + "dockerFilePath": { + "description": "The Docker file path relative to the source location.", + "type": "string" + }, + "target": { + "description": "The name of the target build stage for the docker build.", + "type": "string" + }, + "arguments": { + "description": "The collection of override arguments to be used when executing the run.", + "type": "array", + "items": { + "$ref": "#/definitions/Argument" + } + }, + "timeout": { + "format": "int32", + "description": "Run timeout in seconds.", + "default": 3600, + "maximum": 28800, + "minimum": 300, + "type": "integer" + }, + "platform": { + "$ref": "#/definitions/PlatformProperties", + "description": "The platform properties against which the run has to happen." + }, + "agentConfiguration": { + "$ref": "#/definitions/AgentProperties", + "description": "The machine configuration of the run agent." + }, + "sourceLocation": { + "description": "The URL(absolute or relative) of the source context. It can be an URL to a tar or git repository.\r\nIf it is relative URL, the relative path should be obtained from calling listBuildSourceUploadUrl API.", + "type": "string" + }, + "credentials": { + "$ref": "#/definitions/Credentials", + "description": "The properties that describes a set of credentials that will be used when this run is invoked." + } + }, + "x-ms-discriminator-value": "DockerBuildRequest" + }, + "Argument": { + "description": "The properties of a run argument.", + "required": [ + "name", + "value" + ], + "type": "object", + "properties": { + "name": { + "description": "The name of the argument.", + "type": "string" + }, + "value": { + "description": "The value of the argument.", + "type": "string" + }, + "isSecret": { + "description": "Flag to indicate whether the argument represents a secret and want to be removed from build logs.", + "default": false, + "type": "boolean" + } + } + }, + "FileTaskRunRequest": { + "description": "The request parameters for a scheduling run against a task file.", + "required": [ + "type", + "taskFilePath", + "platform" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/RunRequest" + } + ], + "properties": { + "taskFilePath": { + "description": "The template/definition file path relative to the source.", + "type": "string" + }, + "valuesFilePath": { + "description": "The values/parameters file path relative to the source.", + "type": "string" + }, + "values": { + "description": "The collection of overridable values that can be passed when running a task.", + "type": "array", + "items": { + "$ref": "#/definitions/SetValue" + } + }, + "timeout": { + "format": "int32", + "description": "Run timeout in seconds.", + "default": 3600, + "maximum": 28800, + "minimum": 300, + "type": "integer" + }, + "platform": { + "$ref": "#/definitions/PlatformProperties", + "description": "The platform properties against which the run has to happen." + }, + "agentConfiguration": { + "$ref": "#/definitions/AgentProperties", + "description": "The machine configuration of the run agent." + }, + "sourceLocation": { + "description": "The URL(absolute or relative) of the source context. It can be an URL to a tar or git repository.\r\nIf it is relative URL, the relative path should be obtained from calling listBuildSourceUploadUrl API.", + "type": "string" + }, + "credentials": { + "$ref": "#/definitions/Credentials", + "description": "The properties that describes a set of credentials that will be used when this run is invoked." + } + }, + "x-ms-discriminator-value": "FileTaskRunRequest" + }, + "SetValue": { + "description": "The properties of a overridable value that can be passed to a task template.", + "required": [ + "name", + "value" + ], + "type": "object", + "properties": { + "name": { + "description": "The name of the overridable value.", + "type": "string" + }, + "value": { + "description": "The overridable value.", + "type": "string" + }, + "isSecret": { + "description": "Flag to indicate whether the value represents a secret or not.", + "default": false, + "type": "boolean" + } + } + }, + "TaskRunRequest": { + "description": "The parameters for a task run request.", + "required": [ + "type", + "taskName" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/RunRequest" + } + ], + "properties": { + "taskName": { + "description": "The name of task against which run has to be queued.", + "type": "string" + }, + "values": { + "description": "The collection of overridable values that can be passed when running a task.", + "type": "array", + "items": { + "$ref": "#/definitions/SetValue" + } + } + }, + "x-ms-discriminator-value": "TaskRunRequest" + }, + "EncodedTaskRunRequest": { + "description": "The parameters for a quick task run request.", + "required": [ + "type", + "encodedTaskContent", + "platform" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/RunRequest" + } + ], + "properties": { + "encodedTaskContent": { + "description": "Base64 encoded value of the template/definition file content.", + "type": "string" + }, + "encodedValuesContent": { + "description": "Base64 encoded value of the parameters/values file content.", + "type": "string" + }, + "values": { + "description": "The collection of overridable values that can be passed when running a task.", + "type": "array", + "items": { + "$ref": "#/definitions/SetValue" + } + }, + "timeout": { + "format": "int32", + "description": "Run timeout in seconds.", + "default": 3600, + "maximum": 28800, + "minimum": 300, + "type": "integer" + }, + "platform": { + "$ref": "#/definitions/PlatformProperties", + "description": "The platform properties against which the run has to happen." + }, + "agentConfiguration": { + "$ref": "#/definitions/AgentProperties", + "description": "The machine configuration of the run agent." + }, + "sourceLocation": { + "description": "The URL(absolute or relative) of the source context. It can be an URL to a tar or git repository.\r\nIf it is relative URL, the relative path should be obtained from calling listBuildSourceUploadUrl API.", + "type": "string" + }, + "credentials": { + "$ref": "#/definitions/Credentials", + "description": "The properties that describes a set of credentials that will be used when this run is invoked." + } + }, + "x-ms-discriminator-value": "EncodedTaskRunRequest" + }, + "DockerBuildStep": { + "description": "The Docker build step.", + "required": [ + "dockerFilePath" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TaskStepProperties" + } + ], + "properties": { + "imageNames": { + "description": "The fully qualified image names including the repository and tag.", + "type": "array", + "items": { + "type": "string" + } + }, + "isPushEnabled": { + "description": "The value of this property indicates whether the image built should be pushed to the registry or not.", + "default": true, + "type": "boolean" + }, + "noCache": { + "description": "The value of this property indicates whether the image cache is enabled or not.", + "default": false, + "type": "boolean" + }, + "dockerFilePath": { + "description": "The Docker file path relative to the source context.", + "type": "string" + }, + "target": { + "description": "The name of the target build stage for the docker build.", + "type": "string" + }, + "arguments": { + "description": "The collection of override arguments to be used when executing this build step.", + "type": "array", + "items": { + "$ref": "#/definitions/Argument" + } + } + }, + "x-ms-discriminator-value": "Docker" + }, + "FileTaskStep": { + "description": "The properties of a task step.", + "required": [ + "taskFilePath" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TaskStepProperties" + } + ], + "properties": { + "taskFilePath": { + "description": "The task template/definition file path relative to the source context.", + "type": "string" + }, + "valuesFilePath": { + "description": "The task values/parameters file path relative to the source context.", + "type": "string" + }, + "values": { + "description": "The collection of overridable values that can be passed when running a task.", + "type": "array", + "items": { + "$ref": "#/definitions/SetValue" + } + } + }, + "x-ms-discriminator-value": "FileTask" + }, + "EncodedTaskStep": { + "description": "The properties of a encoded task step.", + "required": [ + "encodedTaskContent" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TaskStepProperties" + } + ], + "properties": { + "encodedTaskContent": { + "description": "Base64 encoded value of the template/definition file content.", + "type": "string" + }, + "encodedValuesContent": { + "description": "Base64 encoded value of the parameters/values file content.", + "type": "string" + }, + "values": { + "description": "The collection of overridable values that can be passed when running a task.", + "type": "array", + "items": { + "$ref": "#/definitions/SetValue" + } + } + }, + "x-ms-discriminator-value": "EncodedTask" + }, + "DockerBuildStepUpdateParameters": { + "description": "The properties for updating a docker build step.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TaskStepUpdateParameters" + } + ], + "properties": { + "imageNames": { + "description": "The fully qualified image names including the repository and tag.", + "type": "array", + "items": { + "type": "string" + } + }, + "isPushEnabled": { + "description": "The value of this property indicates whether the image built should be pushed to the registry or not.", + "type": "boolean" + }, + "noCache": { + "description": "The value of this property indicates whether the image cache is enabled or not.", + "type": "boolean" + }, + "dockerFilePath": { + "description": "The Docker file path relative to the source context.", + "type": "string" + }, + "arguments": { + "description": "The collection of override arguments to be used when executing this build step.", + "type": "array", + "items": { + "$ref": "#/definitions/Argument" + } + }, + "target": { + "description": "The name of the target build stage for the docker build.", + "type": "string" + } + }, + "x-ms-discriminator-value": "Docker" + }, + "FileTaskStepUpdateParameters": { + "description": "The properties of updating a task step.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TaskStepUpdateParameters" + } + ], + "properties": { + "taskFilePath": { + "description": "The task template/definition file path relative to the source context.", + "type": "string" + }, + "valuesFilePath": { + "description": "The values/parameters file path relative to the source context.", + "type": "string" + }, + "values": { + "description": "The collection of overridable values that can be passed when running a task.", + "type": "array", + "items": { + "$ref": "#/definitions/SetValue" + } + } + }, + "x-ms-discriminator-value": "FileTask" + }, + "EncodedTaskStepUpdateParameters": { + "description": "The properties for updating encoded task step.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TaskStepUpdateParameters" + } + ], + "properties": { + "encodedTaskContent": { + "description": "Base64 encoded value of the template/definition file content.", + "type": "string" + }, + "encodedValuesContent": { + "description": "Base64 encoded value of the parameters/values file content.", + "type": "string" + }, + "values": { + "description": "The collection of overridable values that can be passed when running a task.", + "type": "array", + "items": { + "$ref": "#/definitions/SetValue" + } + } + }, + "x-ms-discriminator-value": "EncodedTask" + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "description": "The Microsoft Azure subscription ID.", + "required": true, + "type": "string" + }, + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group to which the container registry belongs.", + "required": true, + "type": "string", + "minLength": 1, + "x-ms-parameter-location": "method" + }, + "RegistryNameParameter": { + "name": "registryName", + "in": "path", + "description": "The name of the container registry.", + "required": true, + "type": "string", + "maxLength": 50, + "minLength": 5, + "pattern": "^[a-zA-Z0-9]*$", + "x-ms-parameter-location": "method" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "The client API version.", + "required": true, + "type": "string" + }, + "TaskNameParameter": { + "name": "taskName", + "in": "path", + "description": "The name of the container registry task.", + "required": true, + "type": "string", + "maxLength": 50, + "minLength": 5, + "pattern": "^[a-zA-Z0-9-_]*$", + "x-ms-parameter-location": "method" + } + }, + "securityDefinitions": { + "azure_auth": { + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + }, + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow" + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] +} \ No newline at end of file diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2019-04-01/examples/ManagedIdentity/TasksCreate_WithSystemAndUserIdentities.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2019-04-01/examples/ManagedIdentity/TasksCreate_WithSystemAndUserIdentities.json new file mode 100644 index 000000000000..66be54f0d11c --- /dev/null +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2019-04-01/examples/ManagedIdentity/TasksCreate_WithSystemAndUserIdentities.json @@ -0,0 +1,242 @@ +{ + "parameters": { + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "myResourceGroup", + "registryName": "myRegistry", + "api-version": "2019-04-01", + "taskName": "mytTask", + "taskCreateParameters": { + "properties": { + "status": "Enabled", + "platform": { + "os": "Linux", + "architecture": "amd64" + }, + "agentConfiguration": { + "cpu": 2 + }, + "step": { + "type": "Docker", + "imageNames": [ + "azurerest:testtag" + ], + "dockerFilePath": "src/DockerFile", + "contextPath": "src", + "isPushEnabled": true, + "noCache": false, + "arguments": [ + { + "name": "mytestargument", + "value": "mytestvalue", + "isSecret": false + }, + { + "name": "mysecrettestargument", + "value": "mysecrettestvalue", + "isSecret": true + } + ] + }, + "trigger":{ + "timerTriggers": [ + { + "name": "myTimerTrigger", + "schedule": "0 30 9 * * 1-5" + } + ], + "sourceTriggers": [ + { + "name": "mySourceTrigger", + "sourceRepository": { + "sourceControlType": "Github", + "repositoryUrl": "https://github.com/Azure/azure-rest-api-specs", + "branch": "master", + "sourceControlAuthProperties": { + "tokenType": "PAT", + "token": "xxxxx" + } + }, + "sourceTriggerEvents":[ + "commit" + ] + } + ], + "baseImageTrigger": { + "name": "myBaseImageTrigger", + "baseImageTriggerType": "Runtime" + } + } + }, + "location": "eastus", + "identity": { + "type": "SystemAssigned, UserAssigned", + "userAssignedIdentities": { + "/subscriptions/f9d7ebed-adbd-4cb4-b973-aaf82c136138/resourcegroups/myResourceGroup1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity2": {} + } + }, + "tags": { + "testkey": "value" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "creationDate": "2018-01-25T06:54:23.536Z", + "status": "Enabled", + "platform": { + "os": "Linux", + "architecture": "amd64" + }, + "agentConfiguration": { + "cpu": 2 + }, + "step": { + "type": "Docker", + "imageNames": [ + "azurerest:testtag" + ], + "dockerFilePath": "src/DockerFile", + "contextPath": "src", + "isPushEnabled": true, + "noCache": false, + "arguments": [ + { + "name": "mytestargument", + "value": "mytestvalue", + "isSecret": false + } + ] + }, + "trigger":{ + "timerTriggers": [ + { + "name": "myTimerTrigger", + "status": "Enabled", + "schedule": "0 30 9 * * 1-5" + } + ], + "sourceTriggers": [ + { + "name": "mySourceTrigger", + "status": "Enabled", + "sourceRepository": { + "sourceControlType": "Github", + "repositoryUrl": "https://github.com/Azure/azure-rest-api-specs", + "branch": "master" + }, + "sourceTriggerEvents":[ + "commit" + ] + } + ], + "baseImageTrigger": { + "name": "myBaseImageTrigger", + "status": "Enabled", + "baseImageTriggerType": "Runtime" + } + } + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/tasks/myTask", + "name": "myTask", + "type": "Microsoft.ContainerRegistry/registries/tasks", + "location": "eastus", + "identity": { + "principalId": "fc99dc67-1ad9-45c8-9ebc-e438081c8e30", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd", + "type": "SystemAssigned, UserAssigned", + "userAssignedIdentities": { + "/subscriptions/f9d7ebed-adbd-4cb4-b973-aaf82c136138/resourcegroups/myResourceGroup1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity2": { + "clientId": "e35621a5-f615-4a20-940e-de8a84b15abc", + "principalId": "e45e3m7c-176e-416a-b466-0c5ec8298f8a" + } + } + }, + "tags": { + "testkey": "value" + } + } + }, + "201": { + "body": { + "properties": { + "provisioningState": "Creating", + "creationDate": "2018-01-25T06:54:23.536Z", + "status": "Enabled", + "platform": { + "os": "Linux", + "architecture": "amd64" + }, + "agentConfiguration": { + "cpu": 2 + }, + "step": { + "type": "Docker", + "imageNames": [ + "azurerest:testtag" + ], + "dockerFilePath": "src/DockerFile", + "contextPath": "src", + "isPushEnabled": true, + "noCache": false, + "arguments": [ + { + "name": "mytestargument", + "value": "mytestvalue", + "isSecret": false + } + ] + }, + "trigger":{ + "timerTriggers": [ + { + "name": "myTimerTrigger", + "status": "Enabled", + "schedule": "0 30 9 * * 1-5" + } + ], + "sourceTriggers": [ + { + "name": "mySourceTrigger", + "status": "Enabled", + "sourceRepository": { + "sourceControlType": "Github", + "repositoryUrl": "https://github.com/Azure/azure-rest-api-specs", + "branch": "master" + }, + "sourceTriggerEvents":[ + "commit" + ] + } + ], + "baseImageTrigger": { + "name": "myBaseImageTrigger", + "status": "Enabled", + "baseImageTriggerType": "Runtime" + } + } + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/tasks/myTask", + "name": "myTask", + "type": "Microsoft.ContainerRegistry/registries/tasks", + "location": "eastus", + "identity": { + "principalId": "fc99dc67-1ad9-45c8-9ebc-e438081c8e30", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd", + "type": "SystemAssigned, UserAssigned", + "userAssignedIdentities": { + "/subscriptions/f9d7ebed-adbd-4cb4-b973-aaf82c136138/resourcegroups/myResourceGroup1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity2": { + "clientId": "e35621a5-f615-4a20-940e-de8a84b15abc", + "principalId": "e45e3m7c-176e-416a-b466-0c5ec8298f8a" + } + } + }, + "tags": { + "testkey": "value" + } + } + } + } +} diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2019-04-01/examples/ManagedIdentity/TasksCreate_WithSystemIdentity.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2019-04-01/examples/ManagedIdentity/TasksCreate_WithSystemIdentity.json new file mode 100644 index 000000000000..512457a1184d --- /dev/null +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2019-04-01/examples/ManagedIdentity/TasksCreate_WithSystemIdentity.json @@ -0,0 +1,227 @@ +{ + "parameters": { + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "myResourceGroup", + "registryName": "myRegistry", + "api-version": "2019-04-01", + "taskName": "mytTask", + "taskCreateParameters": { + "properties": { + "status": "Enabled", + "platform": { + "os": "Linux", + "architecture": "amd64" + }, + "agentConfiguration": { + "cpu": 2 + }, + "step": { + "type": "Docker", + "imageNames": [ + "azurerest:testtag" + ], + "dockerFilePath": "src/DockerFile", + "contextPath": "src", + "isPushEnabled": true, + "noCache": false, + "arguments": [ + { + "name": "mytestargument", + "value": "mytestvalue", + "isSecret": false + }, + { + "name": "mysecrettestargument", + "value": "mysecrettestvalue", + "isSecret": true + } + ] + }, + "trigger": { + "timerTriggers": [ + { + "name": "myTimerTrigger", + "schedule": "0 30 9 * * 1-5" + } + ], + "sourceTriggers": [ + { + "name": "mySourceTrigger", + "sourceRepository": { + "sourceControlType": "Github", + "repositoryUrl": "https://github.com/Azure/azure-rest-api-specs", + "branch": "master", + "sourceControlAuthProperties": { + "tokenType": "PAT", + "token": "xxxxx" + } + }, + "sourceTriggerEvents": [ + "commit" + ] + } + ], + "baseImageTrigger": { + "name": "myBaseImageTrigger", + "baseImageTriggerType": "Runtime" + } + } + }, + "location": "eastus", + "identity": { + "type": "SystemAssigned" + }, + "tags": { + "testkey": "value" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "creationDate": "2018-01-25T06:54:23.536Z", + "status": "Enabled", + "platform": { + "os": "Linux", + "architecture": "amd64" + }, + "agentConfiguration": { + "cpu": 2 + }, + "step": { + "type": "Docker", + "imageNames": [ + "azurerest:testtag" + ], + "dockerFilePath": "src/DockerFile", + "contextPath": "src", + "isPushEnabled": true, + "noCache": false, + "arguments": [ + { + "name": "mytestargument", + "value": "mytestvalue", + "isSecret": false + } + ] + }, + "trigger": { + "timerTriggers": [ + { + "name": "myTimerTrigger", + "status": "Enabled", + "schedule": "0 30 9 * * 1-5" + } + ], + "sourceTriggers": [ + { + "name": "mySourceTrigger", + "status": "Enabled", + "sourceRepository": { + "sourceControlType": "Github", + "repositoryUrl": "https://github.com/Azure/azure-rest-api-specs", + "branch": "master" + }, + "sourceTriggerEvents": [ + "commit" + ] + } + ], + "baseImageTrigger": { + "name": "myBaseImageTrigger", + "status": "Enabled", + "baseImageTriggerType": "Runtime" + } + } + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/tasks/myTask", + "name": "myTask", + "type": "Microsoft.ContainerRegistry/registries/tasks", + "location": "eastus", + "identity": { + "principalId": "fa153151-b9fd-46f4-9088-5e6600f2689v", + "tenantId": "f686d426-8d16-42db-81b7-abu4gm510ccd", + "type": "SystemAssigned" + }, + "tags": { + "testkey": "value" + } + } + }, + "201": { + "body": { + "properties": { + "provisioningState": "Creating", + "creationDate": "2018-01-25T06:54:23.536Z", + "status": "Enabled", + "platform": { + "os": "Linux", + "architecture": "amd64" + }, + "agentConfiguration": { + "cpu": 2 + }, + "step": { + "type": "Docker", + "imageNames": [ + "azurerest:testtag" + ], + "dockerFilePath": "src/DockerFile", + "contextPath": "src", + "isPushEnabled": true, + "noCache": false, + "arguments": [ + { + "name": "mytestargument", + "value": "mytestvalue", + "isSecret": false + } + ] + }, + "trigger": { + "timerTriggers": [ + { + "name": "myTimerTrigger", + "status": "Enabled", + "schedule": "0 30 9 * * 1-5" + } + ], + "sourceTriggers": [ + { + "name": "mySourceTrigger", + "status": "Enabled", + "sourceRepository": { + "sourceControlType": "Github", + "repositoryUrl": "https://github.com/Azure/azure-rest-api-specs", + "branch": "master" + }, + "sourceTriggerEvents": [ + "commit" + ] + } + ], + "baseImageTrigger": { + "name": "myBaseImageTrigger", + "status": "Enabled", + "baseImageTriggerType": "Runtime" + } + } + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/tasks/myTask", + "name": "myTask", + "type": "Microsoft.ContainerRegistry/registries/tasks", + "location": "eastus", + "identity": { + "principalId": "fa153151-b9fd-46f4-9088-5e6600f2689v", + "tenantId": "f686d426-8d16-42db-81b7-abu4gm510ccd", + "type": "SystemAssigned" + }, + "tags": { + "testkey": "value" + } + } + } + } +} \ No newline at end of file diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2019-04-01/examples/ManagedIdentity/TasksCreate_WithUserIdentities.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2019-04-01/examples/ManagedIdentity/TasksCreate_WithUserIdentities.json new file mode 100644 index 000000000000..812553abb310 --- /dev/null +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2019-04-01/examples/ManagedIdentity/TasksCreate_WithUserIdentities.json @@ -0,0 +1,247 @@ +{ + "parameters": { + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "myResourceGroup", + "registryName": "myRegistry", + "api-version": "2019-04-01", + "taskName": "mytTask", + "taskCreateParameters": { + "properties": { + "status": "Enabled", + "platform": { + "os": "Linux", + "architecture": "amd64" + }, + "agentConfiguration": { + "cpu": 2 + }, + "step": { + "type": "Docker", + "imageNames": [ + "azurerest:testtag" + ], + "dockerFilePath": "src/DockerFile", + "contextPath": "src", + "isPushEnabled": true, + "noCache": false, + "arguments": [ + { + "name": "mytestargument", + "value": "mytestvalue", + "isSecret": false + }, + { + "name": "mysecrettestargument", + "value": "mysecrettestvalue", + "isSecret": true + } + ] + }, + "trigger":{ + "timerTriggers": [ + { + "name": "myTimerTrigger", + "schedule": "0 30 9 * * 1-5" + } + ], + "sourceTriggers": [ + { + "name": "mySourceTrigger", + "sourceRepository": { + "sourceControlType": "Github", + "repositoryUrl": "https://github.com/Azure/azure-rest-api-specs", + "branch": "master", + "sourceControlAuthProperties": { + "tokenType": "PAT", + "token": "xxxxx" + } + }, + "sourceTriggerEvents":[ + "commit" + ] + } + ], + "baseImageTrigger": { + "name": "myBaseImageTrigger", + "baseImageTriggerType": "Runtime" + } + } + }, + "location": "eastus", + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/f9d7ebed-adbd-4cb4-b973-aaf82c136138/resourcegroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {}, + "/subscriptions/f9d7ebed-adbd-4cb4-b973-aaf82c136138/resourcegroups/myResourceGroup1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity2": {} + } + }, + "tags": { + "testkey": "value" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "creationDate": "2018-01-25T06:54:23.536Z", + "status": "Enabled", + "platform": { + "os": "Linux", + "architecture": "amd64" + }, + "agentConfiguration": { + "cpu": 2 + }, + "step": { + "type": "Docker", + "imageNames": [ + "azurerest:testtag" + ], + "dockerFilePath": "src/DockerFile", + "contextPath": "src", + "isPushEnabled": true, + "noCache": false, + "arguments": [ + { + "name": "mytestargument", + "value": "mytestvalue", + "isSecret": false + } + ] + }, + "trigger":{ + "timerTriggers": [ + { + "name": "myTimerTrigger", + "status": "Enabled", + "schedule": "0 30 9 * * 1-5" + } + ], + "sourceTriggers": [ + { + "name": "mySourceTrigger", + "status": "Enabled", + "sourceRepository": { + "sourceControlType": "Github", + "repositoryUrl": "https://github.com/Azure/azure-rest-api-specs", + "branch": "master" + }, + "sourceTriggerEvents":[ + "commit" + ] + } + ], + "baseImageTrigger": { + "name": "myBaseImageTrigger", + "status": "Enabled", + "baseImageTriggerType": "Runtime" + } + } + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/tasks/myTask", + "name": "myTask", + "type": "Microsoft.ContainerRegistry/registries/tasks", + "location": "eastus", + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/f9d7ebed-adbd-4cb4-b973-aaf82c136138/resourcegroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": { + "clientId": "d3ce1bc2-f7d7-4a5b-9979-950f4e57680e", + "principalId": "b6p9f58b-6fbf-4efd-a7e0-fvd46911a466" + }, + "/subscriptions/f9d7ebed-adbd-4cb4-b973-aaf82c136138/resourcegroups/myResourceGroup1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity2": { + "clientId": "e35621a5-f615-4a20-940e-de8a84b15abc", + "principalId": "e45e3m7c-176e-416a-b466-0c5ec8298f8a" + } + } + }, + "tags": { + "testkey": "value" + } + } + }, + "201": { + "body": { + "properties": { + "provisioningState": "Creating", + "creationDate": "2018-01-25T06:54:23.536Z", + "status": "Enabled", + "platform": { + "os": "Linux", + "architecture": "amd64" + }, + "agentConfiguration": { + "cpu": 2 + }, + "step": { + "type": "Docker", + "imageNames": [ + "azurerest:testtag" + ], + "dockerFilePath": "src/DockerFile", + "contextPath": "src", + "isPushEnabled": true, + "noCache": false, + "arguments": [ + { + "name": "mytestargument", + "value": "mytestvalue", + "isSecret": false + } + ] + }, + "trigger":{ + "timerTriggers": [ + { + "name": "myTimerTrigger", + "status": "Enabled", + "schedule": "0 30 9 * * 1-5" + } + ], + "sourceTriggers": [ + { + "name": "mySourceTrigger", + "status": "Enabled", + "sourceRepository": { + "sourceControlType": "Github", + "repositoryUrl": "https://github.com/Azure/azure-rest-api-specs", + "branch": "master" + }, + "sourceTriggerEvents":[ + "commit" + ] + } + ], + "baseImageTrigger": { + "name": "myBaseImageTrigger", + "status": "Enabled", + "baseImageTriggerType": "Runtime" + } + } + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/tasks/myTask", + "name": "myTask", + "type": "Microsoft.ContainerRegistry/registries/tasks", + "location": "eastus", + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/f9d7ebed-adbd-4cb4-b973-aaf82c136138/resourcegroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": { + "clientId": "d3ce1bc2-f7d7-4a5b-9979-950f4e57680e", + "principalId": "b6p9f58b-6fbf-4efd-a7e0-fvd46911a466" + }, + "/subscriptions/f9d7ebed-adbd-4cb4-b973-aaf82c136138/resourcegroups/myResourceGroup1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity2": { + "clientId": "e35621a5-f615-4a20-940e-de8a84b15abc", + "principalId": "e45e3m7c-176e-416a-b466-0c5ec8298f8a" + } + } + }, + "tags": { + "testkey": "value" + } + } + } + } +} diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2019-04-01/examples/ManagedIdentity/TasksUpdate_WithKeyVaultCustomCredentials.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2019-04-01/examples/ManagedIdentity/TasksUpdate_WithKeyVaultCustomCredentials.json new file mode 100644 index 000000000000..edbf57228b99 --- /dev/null +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2019-04-01/examples/ManagedIdentity/TasksUpdate_WithKeyVaultCustomCredentials.json @@ -0,0 +1,218 @@ +{ + "parameters": { + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "myResourceGroup", + "registryName": "myRegistry", + "api-version": "2019-04-01", + "taskName": "myTask", + "taskUpdateParameters": { + "properties": { + "status": "Enabled", + "agentConfiguration": { + "cpu": 3 + }, + "step": { + "type": "Docker", + "imageNames": [ + "azurerest:testtag1" + ], + "dockerFilePath": "src/DockerFile" + }, + "trigger": { + "sourceTriggers": [ + { + "name": "mySourceTrigger", + "sourceRepository": { + "sourceControlAuthProperties": { + "tokenType": "PAT", + "token": "xxxxx" + } + }, + "sourceTriggerEvents": [ + "commit" + ] + } + ] + }, + "credentials": { + "customRegistries": { + "myregistry.azurecr.io": { + "userName": { + "type": "Vaultsecret", + "value": "https://myacbvault.vault.azure.net/secrets/username" + }, + "password": { + "type": "Vaultsecret", + "value": "https://myacbvault.vault.azure.net/secrets/password" + }, + "identity": "[system]" + } + } + } + }, + "tags": { + "testkey": "value" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "creationDate": "2018-01-25T06:54:23.536Z", + "status": "Enabled", + "platform": { + "os": "Linux", + "architecture": "amd64" + }, + "agentConfiguration": { + "cpu": 3 + }, + "step": { + "type": "Docker", + "imageNames": [ + "azurerest:testtag1" + ], + "dockerFilePath": "src/DockerFile", + "contextPath": "src", + "isPushEnabled": true, + "noCache": false, + "arguments": [ + { + "name": "mytestargument", + "value": "mytestvalue", + "isSecret": false + } + ] + }, + "trigger": { + "timerTriggers": [ + { + "name": "myTimerTrigger", + "status": "Enabled", + "schedule": "0 30 9 * * 1-5" + } + ], + "sourceTriggers": [ + { + "name": "mySourceTrigger", + "status": "Enabled", + "sourceRepository": { + "sourceControlType": "Github", + "repositoryUrl": "https://github.com/Azure/azure-rest-api-specs", + "branch": "master" + }, + "sourceTriggerEvents": [ + "commit" + ] + } + ], + "baseImageTrigger": { + "name": "myBaseImageTrigger", + "status": "Enabled", + "baseImageTriggerType": "Runtime" + } + }, + "credentials": { + "customRegistries": { + "myregistry.azurecr.io": null + }, + "sourceRegistry": null + } + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/tasks/myTask", + "name": "myTask", + "type": "Microsoft.ContainerRegistry/registries/tasks", + "location": "eastus", + "identity": { + "principalId": "fa153151-b9fd-46f4-9088-5e6600f2689v", + "tenantId": "f686d426-8d16-42db-81b7-abu4gm510ccd", + "type": "SystemAssigned" + }, + "tags": { + "testkey": "value" + } + } + }, + "201": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "creationDate": "2018-01-25T06:54:23.536Z", + "status": "Enabled", + "platform": { + "os": "Linux", + "architecture": "amd64" + }, + "agentConfiguration": { + "cpu": 3 + }, + "step": { + "type": "Docker", + "imageNames": [ + "azurerest:testtag1" + ], + "dockerFilePath": "src/DockerFile", + "contextPath": "src", + "isPushEnabled": true, + "noCache": false, + "arguments": [ + { + "name": "mytestargument", + "value": "mytestvalue", + "isSecret": false + } + ] + }, + "trigger": { + "timerTriggers": [ + { + "name": "myTimerTrigger", + "status": "Enabled", + "schedule": "0 30 9 * * 1-5" + } + ], + "sourceTriggers": [ + { + "name": "mySourceTrigger", + "status": "Enabled", + "sourceRepository": { + "sourceControlType": "Github", + "repositoryUrl": "https://github.com/Azure/azure-rest-api-specs", + "branch": "master" + }, + "sourceTriggerEvents": [ + "commit" + ] + } + ], + "baseImageTrigger": { + "name": "myBaseImageTrigger", + "status": "Enabled", + "baseImageTriggerType": "Runtime" + } + }, + "credentials": { + "customRegistries": { + "myregistry.azurecr.io": null + }, + "sourceRegistry": null + } + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/tasks/myTask", + "name": "myTask", + "type": "Microsoft.ContainerRegistry/registries/tasks", + "location": "eastus", + "identity": { + "principalId": "fa153151-b9fd-46f4-9088-5e6600f2689v", + "tenantId": "f686d426-8d16-42db-81b7-abu4gm510ccd", + "type": "SystemAssigned" + }, + "tags": { + "testkey": "value" + } + } + } + } +} \ No newline at end of file diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2019-04-01/examples/ManagedIdentity/TasksUpdate_WithMSICustomCredentials.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2019-04-01/examples/ManagedIdentity/TasksUpdate_WithMSICustomCredentials.json new file mode 100644 index 000000000000..58f95d75ebcd --- /dev/null +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2019-04-01/examples/ManagedIdentity/TasksUpdate_WithMSICustomCredentials.json @@ -0,0 +1,210 @@ +{ + "parameters": { + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "myResourceGroup", + "registryName": "myRegistry", + "api-version": "2019-04-01", + "taskName": "myTask", + "taskUpdateParameters": { + "properties": { + "status": "Enabled", + "agentConfiguration": { + "cpu": 3 + }, + "step": { + "type": "Docker", + "imageNames": [ + "azurerest:testtag1" + ], + "dockerFilePath": "src/DockerFile" + }, + "trigger": { + "sourceTriggers": [ + { + "name": "mySourceTrigger", + "sourceRepository": { + "sourceControlAuthProperties": { + "tokenType": "PAT", + "token": "xxxxx" + } + }, + "sourceTriggerEvents": [ + "commit" + ] + } + ] + }, + "credentials": { + "customRegistries": { + "myregistry.azurecr.io": { + "identity": "[system]" + } + } + } + }, + "tags": { + "testkey": "value" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "creationDate": "2018-01-25T06:54:23.536Z", + "status": "Enabled", + "platform": { + "os": "Linux", + "architecture": "amd64" + }, + "agentConfiguration": { + "cpu": 3 + }, + "step": { + "type": "Docker", + "imageNames": [ + "azurerest:testtag1" + ], + "dockerFilePath": "src/DockerFile", + "contextPath": "src", + "isPushEnabled": true, + "noCache": false, + "arguments": [ + { + "name": "mytestargument", + "value": "mytestvalue", + "isSecret": false + } + ] + }, + "trigger": { + "timerTriggers": [ + { + "name": "myTimerTrigger", + "status": "Enabled", + "schedule": "0 30 9 * * 1-5" + } + ], + "sourceTriggers": [ + { + "name": "mySourceTrigger", + "status": "Enabled", + "sourceRepository": { + "sourceControlType": "Github", + "repositoryUrl": "https://github.com/Azure/azure-rest-api-specs", + "branch": "master" + }, + "sourceTriggerEvents": [ + "commit" + ] + } + ], + "baseImageTrigger": { + "name": "myBaseImageTrigger", + "status": "Enabled", + "baseImageTriggerType": "Runtime" + } + }, + "credentials": { + "customRegistries": { + "myregistry.azure.io": null + }, + "sourceRegistry": null + } + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/tasks/myTask", + "name": "myTask", + "type": "Microsoft.ContainerRegistry/registries/tasks", + "location": "eastus", + "identity": { + "principalId": "fa153151-b9fd-46f4-9088-5e6600f2689v", + "tenantId": "f686d426-8d16-42db-81b7-abu4gm510ccd", + "type": "SystemAssigned" + }, + "tags": { + "testkey": "value" + } + } + }, + "201": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "creationDate": "2018-01-25T06:54:23.536Z", + "status": "Enabled", + "platform": { + "os": "Linux", + "architecture": "amd64" + }, + "agentConfiguration": { + "cpu": 3 + }, + "step": { + "type": "Docker", + "imageNames": [ + "azurerest:testtag1" + ], + "dockerFilePath": "src/DockerFile", + "contextPath": "src", + "isPushEnabled": true, + "noCache": false, + "arguments": [ + { + "name": "mytestargument", + "value": "mytestvalue", + "isSecret": false + } + ] + }, + "trigger": { + "timerTriggers": [ + { + "name": "myTimerTrigger", + "status": "Enabled", + "schedule": "0 30 9 * * 1-5" + } + ], + "sourceTriggers": [ + { + "name": "mySourceTrigger", + "status": "Enabled", + "sourceRepository": { + "sourceControlType": "Github", + "repositoryUrl": "https://github.com/Azure/azure-rest-api-specs", + "branch": "master" + }, + "sourceTriggerEvents": [ + "commit" + ] + } + ], + "baseImageTrigger": { + "name": "myBaseImageTrigger", + "status": "Enabled", + "baseImageTriggerType": "Runtime" + } + }, + "credentials": { + "customRegistries": { + "myregistry.azure.io": null + }, + "sourceRegistry": null + } + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/tasks/myTask", + "name": "myTask", + "type": "Microsoft.ContainerRegistry/registries/tasks", + "location": "eastus", + "identity": { + "principalId": "fa153151-b9fd-46f4-9088-5e6600f2689v", + "tenantId": "f686d426-8d16-42db-81b7-abu4gm510ccd", + "type": "SystemAssigned" + }, + "tags": { + "testkey": "value" + } + } + } + } +} \ No newline at end of file diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2019-04-01/examples/RegistriesGetBuildSourceUploadUrl.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2019-04-01/examples/RegistriesGetBuildSourceUploadUrl.json new file mode 100644 index 000000000000..6ee37c4a3d9a --- /dev/null +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2019-04-01/examples/RegistriesGetBuildSourceUploadUrl.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "myResourceGroup", + "registryName": "myRegistry", + "api-version": "2019-04-01" + }, + "responses": { + "200": { + "body": { + "relativePath": "source/201802130000/b52f12d8-c3d6-4d75-9107-220f0bfc681d.tar.gz", + "uploadUrl": "https://registrystorageaccount.blob.core.windows.net/registrycontainer/source/201802130000/b52f12d8-c3d6-4d75-9107-220f0bfc681d.tar.gz?sv=2015-04-05&st=2015-04-29T22%3A18%3A26Z&se=2015-04-30T02%3A23%3A26Z&sr=b&sp=rw&sip=168.1.5.60-168.1.5.70&spr=https&sig=Z%2FRHIX5Xcg0Mq2rqI3OlWTjEg2tYkboXr1P9ZUXDtkk%3D" + } + } + } +} \ No newline at end of file diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2019-04-01/examples/RegistriesScheduleRun.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2019-04-01/examples/RegistriesScheduleRun.json new file mode 100644 index 000000000000..fb836139321d --- /dev/null +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2019-04-01/examples/RegistriesScheduleRun.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "myResourceGroup", + "registryName": "myRegistry", + "api-version": "2019-04-01", + "runRequest": { + "type": "DockerBuildRequest", + "isArchiveEnabled": true, + "imageNames": [ + "azurerest:testtag" + ], + "noCache": true, + "sourceLocation": "https://myaccount.blob.core.windows.net/sascontainer/source.zip?sv=2015-04-05&st=2015-04-29T22%3A18%3A26Z&se=2015-04-30T02%3A23%3A26Z&sr=b&sp=rw&sip=168.1.5.60-168.1.5.70&spr=https&sig=Z%2FRHIX5Xcg0Mq2rqI3OlWTjEg2tYkboXr1P9ZUXDtkk%3D", + "arguments": [ + { + "name": "mytestargument", + "value": "mytestvalue", + "isSecret": false + }, + { + "name": "mysecrettestargument", + "value": "mysecrettestvalue", + "isSecret": true + } + ], + "isPushEnabled": true, + "platform": { + "os": "Linux", + "architecture": "amd64" + }, + "agentConfiguration": { + "cpu": 2 + }, + "dockerFilePath": "DockerFile" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "runId": "0accec26-d6de-4757-8e74-d080f38eaaab", + "status": "Succeeded", + "lastUpdatedTime": "2018-01-25T05:13:51.617Z" + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/runs/0accec26-d6de-4757-8e74-d080f38eaaab", + "name": "0accec26-d6de-4757-8e74-d080f38eaaab", + "type": "Microsoft.ContainerRegistry/registries/run" + } + }, + "202": {} + } +} \ No newline at end of file diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2019-04-01/examples/RegistriesScheduleRun_EncodedTaskRun.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2019-04-01/examples/RegistriesScheduleRun_EncodedTaskRun.json new file mode 100644 index 000000000000..39c9eb5457cf --- /dev/null +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2019-04-01/examples/RegistriesScheduleRun_EncodedTaskRun.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "myResourceGroup", + "registryName": "myRegistry", + "api-version": "2019-04-01", + "runRequest": { + "type": "EncodedTaskRunRequest", + "values": [ + { + "name": "mytestargument", + "value": "mytestvalue", + "isSecret": false + }, + { + "name": "mysecrettestargument", + "value": "mysecrettestvalue", + "isSecret": true + } + ], + "platform": { + "os": "Linux" + }, + "agentConfiguration": { + "cpu": 2 + }, + "encodedTaskContent": "c3RlcHM6Cnt7IGlmIFZhbHVlcy5lbnZpcm9ubWVudCA9PSAncHJvZCcgfX0KICAtIHJ1bjogcHJvZCBzZXR1cAp7eyBlbHNlIGlmIFZhbHVlcy5lbnZpcm9ubWVudCA9PSAnc3RhZ2luZycgfX0KICAtIHJ1bjogc3RhZ2luZyBzZXR1cAp7eyBlbHNlIH19CiAgLSBydW46IGRlZmF1bHQgc2V0dXAKe3sgZW5kIH19CgogIC0gcnVuOiBidWlsZCAtdCBGYW5jeVRoaW5nOnt7LlZhbHVlcy5lbnZpcm9ubWVudH19LXt7LlZhbHVlcy52ZXJzaW9ufX0gLgoKcHVzaDogWydGYW5jeVRoaW5nOnt7LlZhbHVlcy5lbnZpcm9ubWVudH19LXt7LlZhbHVlcy52ZXJzaW9ufX0nXQ==", + "encodedValuesContent":"ZW52aXJvbm1lbnQ6IHByb2QKdmVyc2lvbjogMQ==" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "runId": "0accec26-d6de-4757-8e74-d080f38eaaab", + "status": "Succeeded", + "lastUpdatedTime": "2018-01-25T05:13:51.617Z" + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/runs/0accec26-d6de-4757-8e74-d080f38eaaab", + "name": "0accec26-d6de-4757-8e74-d080f38eaaab", + "type": "Microsoft.ContainerRegistry/registries/run" + } + }, + "202": {} + } +} \ No newline at end of file diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2019-04-01/examples/RegistriesScheduleRun_FileTaskRun.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2019-04-01/examples/RegistriesScheduleRun_FileTaskRun.json new file mode 100644 index 000000000000..9775c60694d4 --- /dev/null +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2019-04-01/examples/RegistriesScheduleRun_FileTaskRun.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "myResourceGroup", + "registryName": "myRegistry", + "api-version": "2019-04-01", + "runRequest": { + "type": "FileTaskRunRequest", + "sourceLocation": "https://myaccount.blob.core.windows.net/sascontainer/source.zip?sv=2015-04-05&st=2015-04-29T22%3A18%3A26Z&se=2015-04-30T02%3A23%3A26Z&sr=b&sp=rw&sip=168.1.5.60-168.1.5.70&spr=https&sig=Z%2FRHIX5Xcg0Mq2rqI3OlWTjEg2tYkboXr1P9ZUXDtkk%3D", + "values": [ + { + "name": "mytestargument", + "value": "mytestvalue", + "isSecret": false + }, + { + "name": "mysecrettestargument", + "value": "mysecrettestvalue", + "isSecret": true + } + ], + "platform": { + "os": "Linux" + }, + "agentConfiguration": { + "cpu": 2 + }, + "taskFilePath": "acb.yaml", + "valuesFilePath":"prod-values.yaml" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "runId": "0accec26-d6de-4757-8e74-d080f38eaaab", + "status": "Succeeded", + "lastUpdatedTime": "2018-01-25T05:13:51.617Z" + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/runs/0accec26-d6de-4757-8e74-d080f38eaaab", + "name": "0accec26-d6de-4757-8e74-d080f38eaaab", + "type": "Microsoft.ContainerRegistry/registries/run" + } + }, + "202": {} + } +} \ No newline at end of file diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2019-04-01/examples/RegistriesScheduleRun_FileTask_WithCustomCredentials.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2019-04-01/examples/RegistriesScheduleRun_FileTask_WithCustomCredentials.json new file mode 100644 index 000000000000..5e9cceaf0012 --- /dev/null +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2019-04-01/examples/RegistriesScheduleRun_FileTask_WithCustomCredentials.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "myResourceGroup", + "registryName": "myRegistry", + "api-version": "2019-04-01", + "runRequest": { + "type": "FileTaskRunRequest", + "values": [ + { + "name": "mytestargument", + "value": "mytestvalue", + "isSecret": false + }, + { + "name": "mysecrettestargument", + "value": "mysecrettestvalue", + "isSecret": true + } + ], + "platform": { + "os": "Linux" + }, + "taskFilePath": "acb.yaml", + "credentials": { + "sourceRegistry": { + "loginMode": "Default" + }, + "customRegistries": { + "myregistry.azurecr.io": { + "userName": { + "type": "Opaque", + "value": "reg1" + }, + "password": { + "type": "Opaque", + "value": "***" + } + } + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "runId": "0accec26-d6de-4757-8e74-d080f38eaaab", + "status": "Succeeded", + "lastUpdatedTime": "2018-01-25T05:13:51.617Z" + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/runs/0accec26-d6de-4757-8e74-d080f38eaaab", + "name": "0accec26-d6de-4757-8e74-d080f38eaaab", + "type": "Microsoft.ContainerRegistry/registries/run" + } + }, + "202": {} + } +} \ No newline at end of file diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2019-04-01/examples/RegistriesScheduleRun_Task.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2019-04-01/examples/RegistriesScheduleRun_Task.json new file mode 100644 index 000000000000..a015956b30e6 --- /dev/null +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2019-04-01/examples/RegistriesScheduleRun_Task.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "myResourceGroup", + "registryName": "myRegistry", + "api-version": "2019-04-01", + "runRequest": { + "type": "TaskRunRequest", + "values": [ + { + "name": "mytestargument", + "value": "mytestvalue", + "isSecret": false + }, + { + "name": "mysecrettestargument", + "value": "mysecrettestvalue", + "isSecret": true + } + ], + "taskName": "myTask" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "runId": "0accec26-d6de-4757-8e74-d080f38eaaab", + "status": "Succeeded", + "lastUpdatedTime": "2018-01-25T05:13:51.617Z" + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/runs/0accec26-d6de-4757-8e74-d080f38eaaab", + "name": "0accec26-d6de-4757-8e74-d080f38eaaab", + "type": "Microsoft.ContainerRegistry/registries/run" + } + }, + "202": {} + } +} \ No newline at end of file diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2019-04-01/examples/RegistriesScheduleRun_WithCustomCredentials.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2019-04-01/examples/RegistriesScheduleRun_WithCustomCredentials.json new file mode 100644 index 000000000000..2e959ff4d3fa --- /dev/null +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2019-04-01/examples/RegistriesScheduleRun_WithCustomCredentials.json @@ -0,0 +1,82 @@ +{ + "parameters": { + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "myResourceGroup", + "registryName": "myRegistry", + "api-version": "2019-04-01", + "runRequest": { + "type": "DockerBuildRequest", + "isArchiveEnabled": true, + "imageNames": [ + "azurerest:testtag" + ], + "noCache": true, + "sourceLocation": "https://myaccount.blob.core.windows.net/sascontainer/source.zip?sv=2015-04-05&st=2015-04-29T22%3A18%3A26Z&se=2015-04-30T02%3A23%3A26Z&sr=b&sp=rw&sip=168.1.5.60-168.1.5.70&spr=https&sig=Z%2FRHIX5Xcg0Mq2rqI3OlWTjEg2tYkboXr1P9ZUXDtkk%3D", + "arguments": [ + { + "name": "mytestargument", + "value": "mytestvalue", + "isSecret": false + }, + { + "name": "mysecrettestargument", + "value": "mysecrettestvalue", + "isSecret": true + } + ], + "isPushEnabled": true, + "platform": { + "os": "Linux", + "architecture": "amd64" + }, + "agentConfiguration": { + "cpu": 2 + }, + "dockerFilePath": "DockerFile", + "target": "stage1", + "credentials": { + "sourceRegistry": { + "loginMode": "Default" + }, + "customRegistries": { + "myregistry.azurecr.io": { + "userName": { + "type": "Opaque", + "value": "reg1" + }, + "password": { + "type": "Opaque", + "value": "***" + } + }, + "myregistry2.azurecr.io": { + "userName": { + "type": "Opaque", + "value": "reg2" + }, + "password": { + "type": "Opaque", + "value": "***" + } + } + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "runId": "0accec26-d6de-4757-8e74-d080f38eaaab", + "status": "Succeeded", + "lastUpdatedTime": "2018-01-25T05:13:51.617Z" + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/runs/0accec26-d6de-4757-8e74-d080f38eaaab", + "name": "0accec26-d6de-4757-8e74-d080f38eaaab", + "type": "Microsoft.ContainerRegistry/registries/run" + } + }, + "202": {} + } +} \ No newline at end of file diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2019-04-01/examples/RunsCancel.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2019-04-01/examples/RunsCancel.json new file mode 100644 index 000000000000..aabde8b0d998 --- /dev/null +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2019-04-01/examples/RunsCancel.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "myResourceGroup", + "registryName": "myRegistry", + "api-version": "2019-04-01", + "runId": "0accec26-d6de-4757-8e74-d080f38eaaab" + }, + "responses": { + "200": {}, + "202": {} + } +} \ No newline at end of file diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2019-04-01/examples/RunsGet.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2019-04-01/examples/RunsGet.json new file mode 100644 index 000000000000..f9738b7cfb4a --- /dev/null +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2019-04-01/examples/RunsGet.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "myResourceGroup", + "registryName": "myRegistry", + "api-version": "2019-04-01", + "runId": "0accec26-d6de-4757-8e74-d080f38eaaab" + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "runId": "0accec26-d6de-4757-8e74-d080f38eaaab", + "status": "Succeeded", + "lastUpdatedTime": "2018-01-25T05:13:51.617Z", + "runType": "AutoBuild", + "createTime": "2018-01-25T05:13:51.618Z", + "startTime": "2018-01-25T05:50:51.618Z", + "finishTime": "2018-01-25T06:13:51.618Z", + "outputImages": [ + { + "registry": "myregistry.azurecr.io", + "repository": "myimage", + "tag": "latest", + "digest": "sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0" + } + ], + "task": "myTask", + "imageUpdateTrigger": { + "id": "c0c43143-da5d-41ef-b9e1-e7d749272e88", + "timestamp": "2018-01-25T05:13:51.618Z", + "images": [ + { + "registry": "registry.hub.docker.com", + "repository": "mybaseimage", + "tag": "latest", + "digest": "sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0" + } + ] + }, + "isArchiveEnabled": true, + "platform": { + "os": "Linux", + "architecture": "amd64" + }, + "agentConfiguration": { + "cpu": 2 + } + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/runs/0accec26-d6de-4757-8e74-d080f38eaaab", + "name": "0accec26-d6de-4757-8e74-d080f38eaaab", + "type": "Microsoft.ContainerRegistry/registries/runs" + } + } + } +} \ No newline at end of file diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2019-04-01/examples/RunsGetLogSasUrl.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2019-04-01/examples/RunsGetLogSasUrl.json new file mode 100644 index 000000000000..aa2d1323cba1 --- /dev/null +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2019-04-01/examples/RunsGetLogSasUrl.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "myResourceGroup", + "registryName": "myRegistry", + "api-version": "2019-04-01", + "runId": "0accec26-d6de-4757-8e74-d080f38eaaab" + }, + "responses": { + "200": { + "body": { + "logLink": "https://registrystorageaccount.blob.core.windows.net/sascontainer/logs/0accec26-d6de-4757-8e74-d080f38eaaab/rawtext.log?sv=2015-04-05&st=2015-04-29T22%3A18%3A26Z&se=2015-04-30T02%3A23%3A26Z&sr=b&sp=rw&sip=168.1.5.60-168.1.5.70&spr=https&sig=Z%2FRHIX5Xcg0Mq2rqI3OlWTjEg2tYkboXr1P9ZUXDtkk%3D" + } + } + } +} \ No newline at end of file diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2019-04-01/examples/RunsList.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2019-04-01/examples/RunsList.json new file mode 100644 index 000000000000..13855a4eb1f4 --- /dev/null +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2019-04-01/examples/RunsList.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "myResourceGroup", + "registryName": "myRegistry", + "api-version": "2019-04-01", + "$filter": "", + "$top": 10 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Succeeded", + "runId": "0accec26-d6de-4757-8e74-d080f38eaaab", + "status": "Succeeded", + "lastUpdatedTime": "2018-01-25T05:13:51.617Z", + "runType": "AutoBuild", + "createTime": "2018-01-25T05:13:51.618Z", + "startTime": "2018-01-25T05:50:51.618Z", + "finishTime": "2018-01-25T06:13:51.618Z", + "outputImages": [ + { + "registry": "myregistry.azurecr.io", + "repository": "myimage", + "tag": "latest", + "digest": "sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0" + } + ], + "task": "myTask", + "imageUpdateTrigger": { + "id": "c0c43143-da5d-41ef-b9e1-e7d749272e88", + "timestamp": "2018-01-25T05:13:51.618Z", + "images": [ + { + "registry": "registry.hub.docker.com", + "repository": "mybaseimage", + "tag": "latest", + "digest": "sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0" + } + ] + }, + "isArchiveEnabled": true, + "platform": { + "os": "Linux", + "architecture": "amd64" + }, + "agentConfiguration": { + "cpu": 2 + } + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/runs/0accec26-d6de-4757-8e74-d080f38eaaab", + "name": "0accec26-d6de-4757-8e74-d080f38eaaab", + "type": "Microsoft.ContainerRegistry/registries/runs" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2019-04-01/examples/RunsUpdate.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2019-04-01/examples/RunsUpdate.json new file mode 100644 index 000000000000..441e643d12e3 --- /dev/null +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2019-04-01/examples/RunsUpdate.json @@ -0,0 +1,106 @@ +{ + "parameters": { + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "myResourceGroup", + "registryName": "myRegistry", + "api-version": "2019-04-01", + "runId": "0accec26-d6de-4757-8e74-d080f38eaaab", + "runUpdateParameters": { + "isArchiveEnabled": true + } + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "runId": "0accec26-d6de-4757-8e74-d080f38eaaab", + "status": "Succeeded", + "lastUpdatedTime": "2018-01-25T05:13:51.617Z", + "runType": "AutoBuild", + "createTime": "2018-01-25T05:13:51.618Z", + "startTime": "2018-01-25T05:50:51.618Z", + "finishTime": "2018-01-25T06:13:51.618Z", + "outputImages": [ + { + "registry": "myregistry.azurecr.io", + "repository": "myimage", + "tag": "latest", + "digest": "sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0" + } + ], + "task": "myTask", + "imageUpdateTrigger": { + "id": "c0c43143-da5d-41ef-b9e1-e7d749272e88", + "timestamp": "2018-01-25T05:13:51.618Z", + "images": [ + { + "registry": "registry.hub.docker.com", + "repository": "mybaseimage", + "tag": "latest", + "digest": "sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0" + } + ] + }, + "isArchiveEnabled": true, + "platform": { + "os": "Linux", + "architecture": "amd64" + }, + "agentConfiguration": { + "cpu": 2 + } + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/runs/0accec26-d6de-4757-8e74-d080f38eaaab", + "name": "0accec26-d6de-4757-8e74-d080f38eaaab", + "type": "Microsoft.ContainerRegistry/registries/runs" + } + }, + "201": { + "body": { + "properties": { + "provisioningState": "Updating", + "runId": "0accec26-d6de-4757-8e74-d080f38eaaab", + "status": "Succeeded", + "lastUpdatedTime": "2018-01-25T05:13:51.617Z", + "runType": "AutoBuild", + "createTime": "2018-01-25T05:13:51.618Z", + "startTime": "2018-01-25T05:50:51.618Z", + "finishTime": "2018-01-25T06:13:51.618Z", + "outputImages": [ + { + "registry": "myregistry.azurecr.io", + "repository": "myimage", + "tag": "latest", + "digest": "sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0" + } + ], + "task": "myTask", + "imageUpdateTrigger": { + "id": "c0c43143-da5d-41ef-b9e1-e7d749272e88", + "timestamp": "2018-01-25T05:13:51.618Z", + "images": [ + { + "registry": "registry.hub.docker.com", + "repository": "mybaseimage", + "tag": "latest", + "digest": "sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0" + } + ] + }, + "isArchiveEnabled": true, + "platform": { + "os": "Linux", + "architecture": "amd64" + }, + "agentConfiguration": { + "cpu": 2 + } + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/runs/0accec26-d6de-4757-8e74-d080f38eaaab", + "name": "0accec26-d6de-4757-8e74-d080f38eaaab", + "type": "Microsoft.ContainerRegistry/registries/runs" + } + } + } +} \ No newline at end of file diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2019-04-01/examples/TasksCreate.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2019-04-01/examples/TasksCreate.json new file mode 100644 index 000000000000..512457a1184d --- /dev/null +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2019-04-01/examples/TasksCreate.json @@ -0,0 +1,227 @@ +{ + "parameters": { + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "myResourceGroup", + "registryName": "myRegistry", + "api-version": "2019-04-01", + "taskName": "mytTask", + "taskCreateParameters": { + "properties": { + "status": "Enabled", + "platform": { + "os": "Linux", + "architecture": "amd64" + }, + "agentConfiguration": { + "cpu": 2 + }, + "step": { + "type": "Docker", + "imageNames": [ + "azurerest:testtag" + ], + "dockerFilePath": "src/DockerFile", + "contextPath": "src", + "isPushEnabled": true, + "noCache": false, + "arguments": [ + { + "name": "mytestargument", + "value": "mytestvalue", + "isSecret": false + }, + { + "name": "mysecrettestargument", + "value": "mysecrettestvalue", + "isSecret": true + } + ] + }, + "trigger": { + "timerTriggers": [ + { + "name": "myTimerTrigger", + "schedule": "0 30 9 * * 1-5" + } + ], + "sourceTriggers": [ + { + "name": "mySourceTrigger", + "sourceRepository": { + "sourceControlType": "Github", + "repositoryUrl": "https://github.com/Azure/azure-rest-api-specs", + "branch": "master", + "sourceControlAuthProperties": { + "tokenType": "PAT", + "token": "xxxxx" + } + }, + "sourceTriggerEvents": [ + "commit" + ] + } + ], + "baseImageTrigger": { + "name": "myBaseImageTrigger", + "baseImageTriggerType": "Runtime" + } + } + }, + "location": "eastus", + "identity": { + "type": "SystemAssigned" + }, + "tags": { + "testkey": "value" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "creationDate": "2018-01-25T06:54:23.536Z", + "status": "Enabled", + "platform": { + "os": "Linux", + "architecture": "amd64" + }, + "agentConfiguration": { + "cpu": 2 + }, + "step": { + "type": "Docker", + "imageNames": [ + "azurerest:testtag" + ], + "dockerFilePath": "src/DockerFile", + "contextPath": "src", + "isPushEnabled": true, + "noCache": false, + "arguments": [ + { + "name": "mytestargument", + "value": "mytestvalue", + "isSecret": false + } + ] + }, + "trigger": { + "timerTriggers": [ + { + "name": "myTimerTrigger", + "status": "Enabled", + "schedule": "0 30 9 * * 1-5" + } + ], + "sourceTriggers": [ + { + "name": "mySourceTrigger", + "status": "Enabled", + "sourceRepository": { + "sourceControlType": "Github", + "repositoryUrl": "https://github.com/Azure/azure-rest-api-specs", + "branch": "master" + }, + "sourceTriggerEvents": [ + "commit" + ] + } + ], + "baseImageTrigger": { + "name": "myBaseImageTrigger", + "status": "Enabled", + "baseImageTriggerType": "Runtime" + } + } + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/tasks/myTask", + "name": "myTask", + "type": "Microsoft.ContainerRegistry/registries/tasks", + "location": "eastus", + "identity": { + "principalId": "fa153151-b9fd-46f4-9088-5e6600f2689v", + "tenantId": "f686d426-8d16-42db-81b7-abu4gm510ccd", + "type": "SystemAssigned" + }, + "tags": { + "testkey": "value" + } + } + }, + "201": { + "body": { + "properties": { + "provisioningState": "Creating", + "creationDate": "2018-01-25T06:54:23.536Z", + "status": "Enabled", + "platform": { + "os": "Linux", + "architecture": "amd64" + }, + "agentConfiguration": { + "cpu": 2 + }, + "step": { + "type": "Docker", + "imageNames": [ + "azurerest:testtag" + ], + "dockerFilePath": "src/DockerFile", + "contextPath": "src", + "isPushEnabled": true, + "noCache": false, + "arguments": [ + { + "name": "mytestargument", + "value": "mytestvalue", + "isSecret": false + } + ] + }, + "trigger": { + "timerTriggers": [ + { + "name": "myTimerTrigger", + "status": "Enabled", + "schedule": "0 30 9 * * 1-5" + } + ], + "sourceTriggers": [ + { + "name": "mySourceTrigger", + "status": "Enabled", + "sourceRepository": { + "sourceControlType": "Github", + "repositoryUrl": "https://github.com/Azure/azure-rest-api-specs", + "branch": "master" + }, + "sourceTriggerEvents": [ + "commit" + ] + } + ], + "baseImageTrigger": { + "name": "myBaseImageTrigger", + "status": "Enabled", + "baseImageTriggerType": "Runtime" + } + } + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/tasks/myTask", + "name": "myTask", + "type": "Microsoft.ContainerRegistry/registries/tasks", + "location": "eastus", + "identity": { + "principalId": "fa153151-b9fd-46f4-9088-5e6600f2689v", + "tenantId": "f686d426-8d16-42db-81b7-abu4gm510ccd", + "type": "SystemAssigned" + }, + "tags": { + "testkey": "value" + } + } + } + } +} \ No newline at end of file diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2019-04-01/examples/TasksDelete.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2019-04-01/examples/TasksDelete.json new file mode 100644 index 000000000000..be43f2087a57 --- /dev/null +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2019-04-01/examples/TasksDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "myResourceGroup", + "registryName": "myRegistry", + "api-version": "2019-04-01", + "taskName": "myTask" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} \ No newline at end of file diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2019-04-01/examples/TasksGet.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2019-04-01/examples/TasksGet.json new file mode 100644 index 000000000000..dad97164b37d --- /dev/null +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2019-04-01/examples/TasksGet.json @@ -0,0 +1,90 @@ +{ + "parameters": { + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "myResourceGroup", + "registryName": "myRegistry", + "api-version": "2019-04-01", + "taskName": "myTask" + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "creationDate": "2018-01-25T06:54:23.536Z", + "status": "Enabled", + "platform": { + "os": "Linux", + "architecture": "amd64" + }, + "agentConfiguration": { + "cpu": 2 + }, + "step": { + "type": "Docker", + "imageNames": [ + "azurerest:testtag" + ], + "dockerFilePath": "src/DockerFile", + "contextPath": "src", + "isPushEnabled": true, + "noCache": false, + "arguments": [ + { + "name": "mytestargument", + "value": "mytestvalue", + "isSecret": false + } + ] + }, + "trigger": { + "timerTriggers": [ + { + "name": "myTimerTrigger", + "status": "Enabled", + "schedule": "0 30 9 * * 1-5" + } + ], + "sourceTriggers": [ + { + "name": "mySourceTrigger", + "status": "Enabled", + "sourceRepository": { + "sourceControlType": "Github", + "repositoryUrl": "https://github.com/Azure/azure-rest-api-specs", + "branch": "master" + }, + "sourceTriggerEvents": [ + "commit" + ] + } + ], + "baseImageTrigger": { + "name": "myBaseImageTrigger", + "status": "Enabled", + "baseImageTriggerType": "Runtime" + } + }, + "credentials": { + "customRegistries": { + "myregistry.azure.io": null + }, + "sourceRegistry": null + } + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/tasks/myTask", + "name": "myTask", + "type": "Microsoft.ContainerRegistry/registries/tasks", + "location": "eastus", + "identity": { + "principalId": "fa153151-b9fd-46f4-9088-5e6600f2689v", + "tenantId": "f686d426-8d16-42db-81b7-abu4gm510ccd", + "type": "SystemAssigned" + }, + "tags": { + "testkey": "value" + } + } + } + } +} \ No newline at end of file diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2019-04-01/examples/TasksGetDetails.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2019-04-01/examples/TasksGetDetails.json new file mode 100644 index 000000000000..b25c074842f6 --- /dev/null +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2019-04-01/examples/TasksGetDetails.json @@ -0,0 +1,104 @@ +{ + "parameters": { + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "myResourceGroup", + "registryName": "myRegistry", + "api-version": "2019-04-01", + "taskName": "myTask" + }, + "responses": { + "200": { + "body": { + "properties": { + "status": "Enabled", + "platform": { + "os": "Linux", + "architecture": "amd64" + }, + "agentConfiguration": { + "cpu": 2 + }, + "step": { + "type": "Docker", + "imageNames": [ + "azurerest:testtag" + ], + "dockerFilePath": "src/DockerFile", + "contextPath": "src", + "isPushEnabled": true, + "noCache": false, + "arguments": [ + { + "name": "mytestargument", + "value": "mytestvalue", + "isSecret": false + }, + { + "name": "mysecrettestargument", + "value": "mysecrettestvalue", + "isSecret": true + } + ] + }, + "trigger": { + "timerTriggers": [ + { + "name": "myTimerTrigger", + "status": "Enabled", + "schedule": "0 30 9 * * 1-5" + } + ], + "sourceTriggers": [ + { + "name": "mySourceTrigger", + "status": "Enabled", + "sourceRepository": { + "sourceControlType": "Github", + "repositoryUrl": "https://github.com/Azure/azure-rest-api-specs", + "branch": "master", + "sourceControlAuthProperties": { + "tokenType": "PAT", + "token": "xxxxx" + } + }, + "sourceTriggerEvents": [ + "commit" + ] + } + ], + "baseImageTrigger": { + "name": "myBaseImageTrigger", + "status": "Enabled", + "baseImageTriggerType": "Runtime" + } + }, + "credentials": { + "customRegistries": { + "myregistry.azure-test.io": { + "userName": { + "type": "Opaque", + "value": "username" + }, + "password": { + "type": "Vaultsecret", + "value": "https://myacbvault.vault.azure.net/secrets/username" + }, + "identity": "[system]" + } + }, + "sourceRegistry": null + } + }, + "location": "eastus", + "identity": { + "principalId": "fa153151-b9fd-46f4-9088-5e6600f2689v", + "tenantId": "f686d426-8d16-42db-81b7-abu4gm510ccd", + "type": "SystemAssigned" + }, + "tags": { + "testkey": "value" + } + } + } + } +} \ No newline at end of file diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2019-04-01/examples/TasksList.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2019-04-01/examples/TasksList.json new file mode 100644 index 000000000000..d0388c1778fc --- /dev/null +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2019-04-01/examples/TasksList.json @@ -0,0 +1,93 @@ +{ + "parameters": { + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "myResourceGroup", + "registryName": "myRegistry", + "api-version": "2019-04-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Succeeded", + "creationDate": "2018-01-25T06:54:23.536Z", + "status": "Enabled", + "platform": { + "os": "Linux", + "architecture": "amd64" + }, + "agentConfiguration": { + "cpu": 2 + }, + "step": { + "type": "Docker", + "imageNames": [ + "azurerest:testtag" + ], + "dockerFilePath": "src/DockerFile", + "contextPath": "src", + "isPushEnabled": true, + "noCache": false, + "arguments": [ + { + "name": "mytestargument", + "value": "mytestvalue", + "isSecret": false + } + ] + }, + "trigger": { + "timerTriggers": [ + { + "name": "myTimerTrigger", + "status": "Enabled", + "schedule": "0 30 9 * * 1-5" + } + ], + "sourceTriggers": [ + { + "name": "mySourceTrigger", + "status": "Enabled", + "sourceRepository": { + "sourceControlType": "Github", + "repositoryUrl": "https://github.com/Azure/azure-rest-api-specs", + "branch": "master" + }, + "sourceTriggerEvents": [ + "commit" + ] + } + ], + "baseImageTrigger": { + "name": "myBaseImageTrigger", + "status": "Enabled", + "baseImageTriggerType": "Runtime" + } + }, + "credentials": { + "customRegistries": { + "myRegistry.azure.io": null + }, + "sourceRegistry": null + } + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/tasks/myTask", + "name": "myTask", + "type": "Microsoft.ContainerRegistry/registries/tasks", + "location": "eastus", + "identity": { + "principalId": "fa153151-b9fd-46f4-9088-5e6600f2689v", + "tenantId": "f686d426-8d16-42db-81b7-abu4gm510ccd", + "type": "SystemAssigned" + }, + "tags": { + "testkey": "value" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2019-04-01/examples/TasksUpdate.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2019-04-01/examples/TasksUpdate.json new file mode 100644 index 000000000000..1c5533cf3baf --- /dev/null +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2019-04-01/examples/TasksUpdate.json @@ -0,0 +1,218 @@ +{ + "parameters": { + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "myResourceGroup", + "registryName": "myRegistry", + "api-version": "2019-04-01", + "taskName": "myTask", + "taskUpdateParameters": { + "properties": { + "status": "Enabled", + "agentConfiguration": { + "cpu": 3 + }, + "step": { + "type": "Docker", + "imageNames": [ + "azurerest:testtag1" + ], + "dockerFilePath": "src/DockerFile" + }, + "trigger":{ + "sourceTriggers": [ + { + "name": "mySourceTrigger", + "sourceRepository": { + "sourceControlAuthProperties": { + "tokenType": "PAT", + "token": "xxxxx" + } + }, + "sourceTriggerEvents":[ + "commit" + ] + } + ] + }, + "credentials": { + "customRegistries": { + "myregistry.azurecr.io": { + "userName": { + "type": "Opaque", + "value": "username" + }, + "password": { + "type": "Vaultsecret", + "value": "https://myacbvault.vault.azure.net/secrets/password" + }, + "identity": "[system]" + } + } + } + }, + "tags": { + "testkey": "value" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "creationDate": "2018-01-25T06:54:23.536Z", + "status": "Enabled", + "platform": { + "os": "Linux", + "architecture": "amd64" + }, + "agentConfiguration": { + "cpu": 3 + }, + "step": { + "type": "Docker", + "imageNames": [ + "azurerest:testtag1" + ], + "dockerFilePath": "src/DockerFile", + "contextPath": "src", + "isPushEnabled": true, + "noCache": false, + "arguments": [ + { + "name": "mytestargument", + "value": "mytestvalue", + "isSecret": false + } + ] + }, + "trigger":{ + "timerTriggers": [ + { + "name": "myTimerTrigger", + "status": "Enabled", + "schedule": "0 30 9 * * 1-5" + } + ], + "sourceTriggers": [ + { + "name": "mySourceTrigger", + "status": "Enabled", + "sourceRepository": { + "sourceControlType": "Github", + "repositoryUrl": "https://github.com/Azure/azure-rest-api-specs", + "branch": "master" + }, + "sourceTriggerEvents":[ + "commit" + ] + } + ], + "baseImageTrigger": { + "name": "myBaseImageTrigger", + "status": "Enabled", + "baseImageTriggerType": "Runtime" + } + }, + "credentials": { + "customRegistries": { + "myregistry.azurecr.io": null + }, + "sourceRegistry": null + } + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/tasks/myTask", + "name": "myTask", + "type": "Microsoft.ContainerRegistry/registries/tasks", + "location": "eastus", + "identity": { + "principalId": "fa153151-b9fd-46f4-9088-5e6600f2689v", + "tenantId": "f686d426-8d16-42db-81b7-abu4gm510ccd", + "type": "SystemAssigned" + }, + "tags": { + "testkey": "value" + } + } + }, + "201": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "creationDate": "2018-01-25T06:54:23.536Z", + "status": "Enabled", + "platform": { + "os": "Linux", + "architecture": "amd64" + }, + "agentConfiguration": { + "cpu": 3 + }, + "step": { + "type": "Docker", + "imageNames": [ + "azurerest:testtag1" + ], + "dockerFilePath": "src/DockerFile", + "contextPath": "src", + "isPushEnabled": true, + "noCache": false, + "arguments": [ + { + "name": "mytestargument", + "value": "mytestvalue", + "isSecret": false + } + ] + }, + "trigger":{ + "timerTriggers": [ + { + "name": "myTimerTrigger", + "status": "Enabled", + "schedule": "0 30 9 * * 1-5" + } + ], + "sourceTriggers": [ + { + "name": "mySourceTrigger", + "status": "Enabled", + "sourceRepository": { + "sourceControlType": "Github", + "repositoryUrl": "https://github.com/Azure/azure-rest-api-specs", + "branch": "master" + }, + "sourceTriggerEvents":[ + "commit" + ] + } + ], + "baseImageTrigger": { + "name": "myBaseImageTrigger", + "status": "Enabled", + "baseImageTriggerType": "Runtime" + } + }, + "credentials": { + "customRegistries": { + "myregistry.azurecr.io": null + }, + "sourceRegistry": null + } + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/tasks/myTask", + "name": "myTask", + "type": "Microsoft.ContainerRegistry/registries/tasks", + "location": "eastus", + "identity": { + "principalId": "fa153151-b9fd-46f4-9088-5e6600f2689v", + "tenantId": "f686d426-8d16-42db-81b7-abu4gm510ccd", + "type": "SystemAssigned" + }, + "tags": { + "testkey": "value" + } + } + } + } +} \ No newline at end of file diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2019-04-01/examples/TasksUpdate_WithOpaqueCustomCredentials.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2019-04-01/examples/TasksUpdate_WithOpaqueCustomCredentials.json new file mode 100644 index 000000000000..81121f9eea7d --- /dev/null +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2019-04-01/examples/TasksUpdate_WithOpaqueCustomCredentials.json @@ -0,0 +1,217 @@ +{ + "parameters": { + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "myResourceGroup", + "registryName": "myRegistry", + "api-version": "2019-04-01", + "taskName": "myTask", + "taskUpdateParameters": { + "properties": { + "status": "Enabled", + "agentConfiguration": { + "cpu": 3 + }, + "step": { + "type": "Docker", + "imageNames": [ + "azurerest:testtag1" + ], + "dockerFilePath": "src/DockerFile" + }, + "trigger": { + "sourceTriggers": [ + { + "name": "mySourceTrigger", + "sourceRepository": { + "sourceControlAuthProperties": { + "tokenType": "PAT", + "token": "xxxxx" + } + }, + "sourceTriggerEvents": [ + "commit" + ] + } + ] + }, + "credentials": { + "customRegistries": { + "myregistry.azurecr.io": { + "userName": { + "type": "Opaque", + "value": "username" + }, + "password": { + "type": "Opaque", + "value": "***" + } + } + } + } + }, + "tags": { + "testkey": "value" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "creationDate": "2018-01-25T06:54:23.536Z", + "status": "Enabled", + "platform": { + "os": "Linux", + "architecture": "amd64" + }, + "agentConfiguration": { + "cpu": 3 + }, + "step": { + "type": "Docker", + "imageNames": [ + "azurerest:testtag1" + ], + "dockerFilePath": "src/DockerFile", + "contextPath": "src", + "isPushEnabled": true, + "noCache": false, + "arguments": [ + { + "name": "mytestargument", + "value": "mytestvalue", + "isSecret": false + } + ] + }, + "trigger": { + "timerTriggers": [ + { + "name": "myTimerTrigger", + "status": "Enabled", + "schedule": "0 30 9 * * 1-5" + } + ], + "sourceTriggers": [ + { + "name": "mySourceTrigger", + "status": "Enabled", + "sourceRepository": { + "sourceControlType": "Github", + "repositoryUrl": "https://github.com/Azure/azure-rest-api-specs", + "branch": "master" + }, + "sourceTriggerEvents": [ + "commit" + ] + } + ], + "baseImageTrigger": { + "name": "myBaseImageTrigger", + "status": "Enabled", + "baseImageTriggerType": "Runtime" + } + }, + "credentials": { + "customRegistries": { + "myregistry.azure.io": null + }, + "sourceRegistry": null + } + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/tasks/myTask", + "name": "myTask", + "type": "Microsoft.ContainerRegistry/registries/tasks", + "location": "eastus", + "identity": { + "principalId": "fa153151-b9fd-46f4-9088-5e6600f2689v", + "tenantId": "f686d426-8d16-42db-81b7-abu4gm510ccd", + "type": "SystemAssigned" + }, + "tags": { + "testkey": "value" + } + } + }, + "201": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "creationDate": "2018-01-25T06:54:23.536Z", + "status": "Enabled", + "platform": { + "os": "Linux", + "architecture": "amd64" + }, + "agentConfiguration": { + "cpu": 3 + }, + "step": { + "type": "Docker", + "imageNames": [ + "azurerest:testtag1" + ], + "dockerFilePath": "src/DockerFile", + "contextPath": "src", + "isPushEnabled": true, + "noCache": false, + "arguments": [ + { + "name": "mytestargument", + "value": "mytestvalue", + "isSecret": false + } + ] + }, + "trigger": { + "timerTriggers": [ + { + "name": "myTimerTrigger", + "status": "Enabled", + "schedule": "0 30 9 * * 1-5" + } + ], + "sourceTriggers": [ + { + "name": "mySourceTrigger", + "status": "Enabled", + "sourceRepository": { + "sourceControlType": "Github", + "repositoryUrl": "https://github.com/Azure/azure-rest-api-specs", + "branch": "master" + }, + "sourceTriggerEvents": [ + "commit" + ] + } + ], + "baseImageTrigger": { + "name": "myBaseImageTrigger", + "status": "Enabled", + "baseImageTriggerType": "Runtime" + } + }, + "credentials": { + "customRegistries": { + "myregistry.azure.io": null + }, + "sourceRegistry": null + } + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/tasks/myTask", + "name": "myTask", + "type": "Microsoft.ContainerRegistry/registries/tasks", + "location": "eastus", + "identity": { + "principalId": "fa153151-b9fd-46f4-9088-5e6600f2689v", + "tenantId": "f686d426-8d16-42db-81b7-abu4gm510ccd", + "type": "SystemAssigned" + }, + "tags": { + "testkey": "value" + } + } + } + } +} \ No newline at end of file diff --git a/specification/containerregistry/resource-manager/readme.go.md b/specification/containerregistry/resource-manager/readme.go.md index 1712041f331b..6008e706debf 100644 --- a/specification/containerregistry/resource-manager/readme.go.md +++ b/specification/containerregistry/resource-manager/readme.go.md @@ -13,6 +13,7 @@ go: ``` yaml $(go) && $(multiapi) batch: + - tag: package-2019-04 - tag: package-2018-09 - tag: package-2018-02-preview - tag: package-2017-10 @@ -23,6 +24,15 @@ batch: ### Tag: package-2018-09 and go +These settings apply only when `--tag=package-2019-04 --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-2019-04' && $(go) +output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2019-04-01/$(namespace) +``` + +### Tag: package-2018-09 and go + These settings apply only when `--tag=package-2018-09 --go` is specified on the command line. Please also specify `--go-sdk-folder=`. diff --git a/specification/containerregistry/resource-manager/readme.md b/specification/containerregistry/resource-manager/readme.md index 81572079fa6c..dd76ce01c32a 100644 --- a/specification/containerregistry/resource-manager/readme.md +++ b/specification/containerregistry/resource-manager/readme.md @@ -26,7 +26,17 @@ These are the global settings for the ContainerRegistry API. ``` yaml openapi-type: arm -tag: package-2018-09 +tag: package-2019-04 +``` + +### Tag: package-2019-04 + +These settings apply only when `--tag=package-2019-04` is specified on the command line. + +``` yaml $(tag) == 'package-2019-04' +input-file: +- Microsoft.ContainerRegistry/stable/2017-10-01/containerregistry.json +- Microsoft.ContainerRegistry/stable/2019-04-01/containerregistry_build.json ``` ### Tag: package-2018-09 @@ -151,6 +161,7 @@ output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-containerregistry ``` yaml $(java) && $(multiapi) batch: + - tag: package-2019-04 - tag: package-2018-09 - tag: package-2018-02-preview - tag: package-2017-10 @@ -159,6 +170,19 @@ batch: - tag: package-2016-06-preview ``` +### Tag: package-2019-04 and java + +These settings apply only when `--tag=package-2019-04 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-2019-04' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.containerregistry.v2019_04_01 + output-folder: $(azure-libraries-for-java-folder)/containerregistry/resource-manager/v2019_04_01 +regenerate-manager: true +generate-interface: true +``` + ### Tag: package-2018-09 and java These settings apply only when `--tag=package-2018-09 --java` is specified on the command line. @@ -235,4 +259,4 @@ java: output-folder: $(azure-libraries-for-java-folder)/containerregistry/resource-manager/v2016_06_27_preview regenerate-manager: true generate-interface: true -``` +``` \ No newline at end of file diff --git a/specification/containerregistry/resource-manager/readme.nodejs.md b/specification/containerregistry/resource-manager/readme.nodejs.md index 4f2d10d3f741..b6274aeed389 100644 --- a/specification/containerregistry/resource-manager/readme.nodejs.md +++ b/specification/containerregistry/resource-manager/readme.nodejs.md @@ -13,5 +13,5 @@ nodejs: generate-readme-md: true input-file: - Microsoft.ContainerRegistry/stable/2017-10-01/containerregistry.json -- Microsoft.ContainerRegistry/stable/2018-09-01/containerregistry_build.json +- Microsoft.ContainerRegistry/stable/2019-04-01/containerregistry_build.json ``` diff --git a/specification/containerregistry/resource-manager/readme.python.md b/specification/containerregistry/resource-manager/readme.python.md index b73d84808626..69581f810e7c 100644 --- a/specification/containerregistry/resource-manager/readme.python.md +++ b/specification/containerregistry/resource-manager/readme.python.md @@ -18,12 +18,24 @@ Generate all API versions currently shipped for this package ```yaml $(python) && $(multiapi) batch: + - tag: package-2019-04 - tag: package-2018-09 - tag: package-2018-02-preview - tag: package-2017-10 - tag: package-2017-03 ``` +### 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' && $(python) +python: + namespace: azure.mgmt.containerregistry.v2019_04_01 + output-folder: $(python-sdks-folder)/azure-mgmt-containerregistry/azure/mgmt/containerregistry/v2019_04_01 +``` + ### Tag: package-2018-09 and python These settings apply only when `--tag=package-2018-09 --python` is specified on the command line. diff --git a/specification/containerregistry/resource-manager/readme.typescript.md b/specification/containerregistry/resource-manager/readme.typescript.md index 4105b3247826..699119fdad05 100644 --- a/specification/containerregistry/resource-manager/readme.typescript.md +++ b/specification/containerregistry/resource-manager/readme.typescript.md @@ -6,7 +6,7 @@ Please also specify `--typescript-sdks-folder=`. -``` yaml $(tag) == 'package-2018-06-01-preview' && $(go) -output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2018-06-01-preview/$(namespace) +``` yaml $(tag) == 'package-2019-04-01' && $(go) +output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2019-04-01/$(namespace) ``` ### Tag: package-2019-01-01-preview and go @@ -33,4 +34,13 @@ Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-2018-06-01-preview' && $(go) +output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2018-06-01-preview/$(namespace) ``` \ No newline at end of file diff --git a/specification/devspaces/resource-manager/readme.md b/specification/devspaces/resource-manager/readme.md index 63db9ebec0aa..ab71943b48ae 100644 --- a/specification/devspaces/resource-manager/readme.md +++ b/specification/devspaces/resource-manager/readme.md @@ -27,7 +27,16 @@ These are the global settings for the DevSpaces API. title: DevSpacesManagementClient description: Dev Spaces Client openapi-type: arm -tag: package-2019-01-01-preview +tag: package-2019-04-01 +``` + +### Tag: package-2019-04-01 + +These settings apply only when `--tag=package-2019-04-01` is specified on the command line. + +``` yaml $(tag) == 'package-2019-04-01' +input-file: +- Microsoft.DevSpaces/stable/2019-04-01/devspaces.json ``` ### Tag: package-2019-01-01-preview diff --git a/specification/devspaces/resource-manager/readme.nodejs.md b/specification/devspaces/resource-manager/readme.nodejs.md index e9a58cb519be..bb64405b8fe8 100644 --- a/specification/devspaces/resource-manager/readme.nodejs.md +++ b/specification/devspaces/resource-manager/readme.nodejs.md @@ -11,4 +11,6 @@ nodejs: generate-license-txt: true generate-package-json: true generate-readme-md: true +input-file: +- Microsoft.DevSpaces/stable/2019-04-01/devspaces.json ``` diff --git a/specification/dns/resource-manager/readme.csharp.md b/specification/dns/resource-manager/readme.csharp.md new file mode 100644 index 000000000000..297a9fed7a57 --- /dev/null +++ b/specification/dns/resource-manager/readme.csharp.md @@ -0,0 +1,53 @@ +# C# Compute + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for DNS. + +These settings apply only when `--csharp` is specified on the command line. +Please also specify `--csharp-sdks-folder=`. + +## Common C# settings + +## 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: 2 + clear-output-folder: true +``` + +### Profile: hybrid_2018_03_01 + +These settings apply only when `--profile=hybrid_2018_03_01` is specified on the command line. + +```yaml $(profile)=='hybrid_2018_03_01' +namespace: Microsoft.Azure.Management.Profiles.$(profile).Dns +output-folder: $(csharp-sdks-folder)/$(profile)/Dns/Management.Dns/Generated + +batch: + - tag: package-2016-04 + +skip-simplifier-on-namespace: + - System.Net +``` + +### Profile: profile_2017_03_09 + +These settings apply only when `--profile=profile_2017_03_09` is specified on the command line. + +``` yaml $(profile)=='profile_2017_03_09' +namespace: Microsoft.Azure.Management.Profiles.$(profile).Dns +output-folder: $(csharp-sdks-folder)/$(profile)/Dns/Management.Dns/Generated + +batch: + - tag: package-2016-04 + +skip-simplifier-on-namespace: + - System.Net +``` \ No newline at end of file diff --git a/specification/dns/resource-manager/readme.md b/specification/dns/resource-manager/readme.md index 687dde4dc843..690bdbff06d0 100644 --- a/specification/dns/resource-manager/readme.md +++ b/specification/dns/resource-manager/readme.md @@ -162,21 +162,6 @@ swagger-to-sdk: - bundle install && rake arm:regen_all_profiles['azure_mgmt_dns'] ``` -## 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 - namespace: Microsoft.Azure.Management.Dns - payload-flattening-threshold: 2 - output-folder: $(csharp-sdks-folder)/Dns/Management.Dns/Generated - clear-output-folder: true -``` - ## Go See configuration in [readme.go.md](./readme.go.md) @@ -227,4 +212,4 @@ java: output-folder: $(azure-libraries-for-java-folder)/dns/resource-manager/v2016_04_01 regenerate-manager: true generate-interface: true -``` +``` \ No newline at end of file diff --git a/specification/dynamicstelemetry/resource-manager/Microsoft.DynamicsTelemetry/preview/2019-01-24/dynamicstelemetry.json b/specification/dynamicstelemetry/resource-manager/Microsoft.DynamicsTelemetry/preview/2019-01-24/dynamicstelemetry.json new file mode 100644 index 000000000000..2c26009a3e89 --- /dev/null +++ b/specification/dynamicstelemetry/resource-manager/Microsoft.DynamicsTelemetry/preview/2019-01-24/dynamicstelemetry.json @@ -0,0 +1,142 @@ +{ + "swagger": "2.0", + "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" + } + } + }, + "info": { + "title": "Dynamics Telemetry", + "version": "2019-01-24" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "paths": { + "/providers/Microsoft.DynamicsTelemetry/operations": { + "get": { + "tags": [ + "Operations" + ], + "operationId": "Operations_List", + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationList" + } + }, + "204": { + "description": "No Content" + } + }, + "x-ms-examples": { + "List Operations": { + "$ref": "./examples/Operations_List.json" + } + } + } + } + }, + "definitions": { + "OperationList": { + "type": "array", + "description": "List of supported operations.", + "items": { + "$ref": "#/definitions/Operation" + } + }, + "Operation": { + "type": "object", + "additionalProperties": false, + "required": [ + "isDataAction" + ], + "properties": { + "origin": { + "type": "string" + }, + "name": { + "type": "string" + }, + "display": { + "$ref": "#/definitions/Display" + }, + "properties": { + "$ref": "#/definitions/Properties" + }, + "isDataAction": { + "type": "boolean" + } + } + }, + "Display": { + "type": "object", + "additionalProperties": false, + "properties": { + "provider": { + "type": "string" + }, + "resource": { + "type": "string" + }, + "operation": { + "type": "string" + }, + "description": { + "type": "string" + }, + "publisher": { + "type": "string" + } + } + }, + "Properties": { + "type": "object", + "additionalProperties": false, + "properties": { + "serviceSpecification": { + "$ref": "#/definitions/ServiceSpecification" + } + } + }, + "ServiceSpecification": { + "type": "object", + "additionalProperties": false, + "properties": { + "logSpecifications": { + "type": "array", + "items": { + "$ref": "#/definitions/LogSpecification" + } + } + } + }, + "LogSpecification": { + "type": "object", + "additionalProperties": false, + "properties": { + "name": { + "type": "string" + }, + "displayName": { + "type": "string" + }, + "blobDuration": { + "type": "string", + "format": "duration" + } + } + } + } +} diff --git a/specification/dynamicstelemetry/resource-manager/Microsoft.DynamicsTelemetry/preview/2019-01-24/examples/Operations_List.json b/specification/dynamicstelemetry/resource-manager/Microsoft.DynamicsTelemetry/preview/2019-01-24/examples/Operations_List.json new file mode 100644 index 000000000000..8cda204e5701 --- /dev/null +++ b/specification/dynamicstelemetry/resource-manager/Microsoft.DynamicsTelemetry/preview/2019-01-24/examples/Operations_List.json @@ -0,0 +1,95 @@ +{ + "parameters": { + "api-version": "2019-01-24" + }, + "responses": { + "200": { + "body": [{ + "origin": "system", + "name": "microsoft.dynamicstelemetry/tenants/providers/Microsoft.Insights/logDefinitions/read", + "display": { + "provider": "Microsoft Dynamics Telemetry", + "resource": "Log definition", + "operation": "Read tenants log definitions", + "description": "Gets the available logs for tenants" + }, + "properties": {}, + "isDataAction": false + }, + { + "origin": "system", + "name": "microsoft.dynamicstelemetry/tenants/providers/Microsoft.Insights/diagnosticSettings/read", + "display": { + "provider": "Microsoft Dynamics Telemetry", + "resource": "tenants", + "operation": "Read diagnostic setting", + "description": "Gets the diagnostic setting for the resource" + }, + "isDataAction": false + }, + { + "origin": "system", + "name": "microsoft.dynamicstelemetry/tenants/providers/Microsoft.Insights/diagnosticSettings/write", + "display": { + "provider": "Microsoft Dynamics Telemetry", + "resource": "tenants", + "operation": "Write diagnostic setting", + "description": "Creates or updates the diagnostic setting for the resource" + }, + "isDataAction": false + }, + { + "name": "microsoft.dynamicstelemetry/diagnosticsettings/write", + "display": { + "provider": "Microsoft Monitoring Insights", + "resource": "Diagnostic settings", + "operation": "Diagnostic settings write", + "description": "Writing a diagnostic setting", + "publisher": "Microsoft" + }, + "properties": {}, + "isDataAction": false + }, + { + "name": "microsoft.dynamicstelemetry/diagnosticsettings/read", + "display": { + "provider": "Microsoft Monitoring Insights", + "resource": "Diagnostic settings", + "operation": "Diagnostic settings read", + "description": "Reading a diagnostic setting", + "publisher": "Microsoft" + }, + "properties": {}, + "isDataAction": false + }, + { + "name": "microsoft.dynamicstelemetry/diagnosticsettings/delete", + "display": { + "provider": "Microsoft Monitoring Insights", + "resource": "Diagnostic settings", + "operation": "Diagnostic settings delete", + "description": "Deleting a diagnostic setting", + "publisher": "Microsoft" + }, + "properties": {}, + "isDataAction": false + }, + { + "name": "microsoft.dynamicstelemetry/diagnosticsettingscategories/read", + "display": { + "provider": "Microsoft Monitoring Insights", + "resource": "Diagnostic settings categories", + "operation": "Diagnostic settings categories read", + "description": "Reading a diagnostic setting categories", + "publisher": "Microsoft" + }, + "properties": {}, + "isDataAction": false + } + ] + + }, + "204": { + } + } +} diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/EventHub-preview.json b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/EventHub-preview.json index b14aa2e86ebe..c29b8fb3c842 100644 --- a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/EventHub-preview.json +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/EventHub-preview.json @@ -70,6 +70,42 @@ } } }, + "/subscriptions/{subscriptionId}/providers/Microsoft.EventHub/availableClusters": { + "get": { + "tags": [ + "Event Hubs Clusters" + ], + "operationId": "Clusters_ListAvailableClusters", + "x-ms-examples": { + "ListAvailableClusters": { + "$ref": "./examples/Clusters/ListAvailableClustersGet.json" + } + }, + "description": "List the quantity of available pre-provisioned Event Hubs Clusters, indexed by Azure region.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Available clusters listed successfully.", + "schema": { + "$ref": "#/definitions/AvailableClustersList" + } + }, + "default": { + "description": "Error response describing why available clusters could not be successfully listed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/clusters": { "get": { "tags": [ @@ -153,6 +189,56 @@ } } }, + "put": { + "tags": [ + "Event Hubs Cluster" + ], + "operationId": "Clusters_Put", + "x-ms-examples": { + "ClusterPut": { + "$ref": "./examples/Clusters/ClusterPut.json" + } + }, + "description": "Creates or updates an instance of an Event Hubs Cluster.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Event Hubs Cluster successfully created or updated.", + "schema": { + "$ref": "#/definitions/Cluster" + } + }, + "201": { + "description": "Event Hubs Cluster create or update request accepted.", + "schema": { + "$ref": "#/definitions/Cluster" + } + }, + "202": { + "description": "Event Hubs Cluster create or update request accepted." + }, + "default": { + "description": "Event Hubs error response detailing why the Event Hubs Cluster create or update operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, "patch": { "tags": [ "Event Hubs Cluster" @@ -211,6 +297,92 @@ } }, "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "Event Hubs Cluster" + ], + "operationId": "Clusters_Delete", + "x-ms-examples": { + "ClusterDelete": { + "$ref": "./examples/Clusters/ClusterDelete.json" + } + }, + "description": "Deletes an existing Event Hubs Cluster. This operation is idempotent.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Event Hubs Cluster successfully deleted." + }, + "202": { + "description": "Event Hubs Cluster delete request accepted." + }, + "204": { + "description": "No content." + }, + "default": { + "description": "Event Hubs error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/clusters/{clusterName}/namespaces": { + "get": { + "tags": [ + "Event Hubs Namespace Enumeration in Cluster" + ], + "operationId": "Clusters_ListNamespaces", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "description": "List all Event Hubs Namespace IDs in an Event Hubs Dedicated Cluster.", + "x-ms-examples": { + "ListNamespacesInCluster": { + "$ref": "./examples/Clusters/ListNamespacesInClusterGet.json" + } + }, + "responses": { + "200": { + "description": "List of Namespace IDs in Cluster successfully delivered.", + "schema": { + "$ref": "#/definitions/EHNamespaceIdListResult" + } + }, + "default": { + "description": "Event Hubs Cluster error response detailing why this operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/clusters/{clusterName}/quotaConfiguration/default": { @@ -436,14 +608,14 @@ } ], "responses": { - "201": { - "description": "Namespace create request accepted.", + "200": { + "description": "Namespace successfully created.", "schema": { "$ref": "#/definitions/EHNamespace" } }, - "200": { - "description": "Namespace successfully created.", + "201": { + "description": "Namespace create request accepted.", "schema": { "$ref": "#/definitions/EHNamespace" } @@ -486,15 +658,15 @@ } ], "responses": { - "204": { - "description": "No content." - }, "200": { "description": "Namespace successfully deleted." }, "202": { "description": "Namespace delete request accepted." }, + "204": { + "description": "No content." + }, "default": { "description": "Eventhub error response describing why the operation failed.", "schema": { @@ -585,14 +757,14 @@ } ], "responses": { - "201": { - "description": "Namespace update request accepted.", + "200": { + "description": "Namespace successfully updated.", "schema": { "$ref": "#/definitions/EHNamespace" } }, - "200": { - "description": "Namespace successfully updated.", + "201": { + "description": "Namespace update request accepted.", "schema": { "$ref": "#/definitions/EHNamespace" } @@ -736,12 +908,12 @@ } ], "responses": { - "204": { - "description": "No content." - }, "200": { "description": "Namespace IpFilterRule successfully deleted." }, + "204": { + "description": "No content." + }, "default": { "description": "Eventhub error response describing why the operation failed.", "schema": { @@ -921,12 +1093,12 @@ } ], "responses": { - "204": { - "description": "No content." - }, "200": { "description": "Namespace VirtualNetworkRule successfully deleted." }, + "204": { + "description": "No content." + }, "default": { "description": "Eventhub error response describing why the operation failed.", "schema": { @@ -1156,6 +1328,25 @@ ], "description": "Single Event Hubs Cluster resource in List or Get operations." }, + "AvailableClustersList": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/AvailableCluster" + }, + "description": "The count of readily available and pre-provisioned Event Hubs Clusters per region." + } + }, + "description": "The response of the List Available Clusters operation." + }, + "AvailableCluster": { + "type": "object", + "additionalProperties": { + "type": "integer" + }, + "description": "Pre-provisioned and readily available Event Hubs Cluster count per region." + }, "ClusterListResult": { "properties": { "value": { @@ -1276,6 +1467,27 @@ ], "description": "SKU parameters particular to a cluster instance." }, + "EHNamespaceIdListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/EHNamespaceIdContainer" + }, + "description": "Result of the List Namespace IDs operation" + } + }, + "description": "The response of the List Namespace IDs operation" + }, + "EHNamespaceIdContainer": { + "type": "object", + "properties": { + "id": { + "type": "string" + } + }, + "description": "The full ARM ID of an Event Hubs Namespace" + }, "EHNamespaceListResult": { "properties": { "value": { @@ -1676,4 +1888,4 @@ "x-ms-parameter-location": "method" } } -} \ No newline at end of file +} diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/examples/Clusters/ClusterDelete.json b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/examples/Clusters/ClusterDelete.json new file mode 100644 index 000000000000..7ba2aa0baf20 --- /dev/null +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/examples/Clusters/ClusterDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "clusterName": "testCluster", + "resourceGroupName": "myResourceGroup", + "api-version": "2018-01-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/examples/Clusters/ClusterPut.json b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/examples/Clusters/ClusterPut.json new file mode 100644 index 000000000000..d71150f6dfbc --- /dev/null +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/examples/Clusters/ClusterPut.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "clusterName": "testCluster", + "resourceGroupName": "myResourceGroup", + "api-version": "2018-01-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4", + "parameters": { + "sku": { + "tier": "Dedicated", + "capacity": 1 + }, + "location": "South Central US", + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/myResourceGroup/providers/Microsoft.EventHub/clusters/testCluster", + "name": "testCluster", + "type": "Microsoft.EventHub/Clusters", + "location": "South Central US", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "sku": { + "name": "Dedicated", + "capacity": 1 + }, + "properties": { + "created": "2017-05-24T23:23:27.877Z", + "updated": "2017-05-24T23:23:27.877Z", + "metricId": "SN6-008" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/myResourceGroup/providers/Microsoft.EventHub/clusters/testCluster", + "name": "testCluster", + "type": "Microsoft.EventHub/Clusters", + "location": "South Central US", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "sku": { + "name": "Dedicated", + "capacity": 1 + }, + "properties": { + "created": "2017-05-24T23:23:27.877Z", + "updated": "2017-05-24T23:23:27.877Z", + "metricId": "SN6-008" + } + } + }, + "202" : {} + } +} diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/examples/Clusters/ListAvailableClustersGet.json b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/examples/Clusters/ListAvailableClustersGet.json new file mode 100644 index 000000000000..cae1cee27c48 --- /dev/null +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/examples/Clusters/ListAvailableClustersGet.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2018-01-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "westus": 5 + }, + { + "eastus": 4 + } + ] + } + } + } +} diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/examples/Clusters/ListNamespacesInClusterGet.json b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/examples/Clusters/ListNamespacesInClusterGet.json new file mode 100644 index 000000000000..8d78ebd0cf63 --- /dev/null +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/examples/Clusters/ListNamespacesInClusterGet.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "clusterName": "testCluster", + "resourceGroupName": "myResourceGroup", + "api-version": "2018-01-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-EventHub-SouthCentralUS/providers/Microsoft.EventHub/namespaces/rrama-int7-ns1" + }, + { + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-EventHub-SouthCentralUS/providers/Microsoft.EventHub/namespaces/rrama-ehns2-int7" + }, + { + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.EventHub/namespaces/db3-rrama-foo1" + } + ] + } + } + } +} diff --git a/specification/hanaonazure/resource-manager/Microsoft.HanaOnAzure/preview/2017-11-03-preview/examples/HanaInstances_EnableMonitoring.json b/specification/hanaonazure/resource-manager/Microsoft.HanaOnAzure/preview/2017-11-03-preview/examples/HanaInstances_EnableMonitoring.json index 2282319c8930..c620c02ec950 100644 --- a/specification/hanaonazure/resource-manager/Microsoft.HanaOnAzure/preview/2017-11-03-preview/examples/HanaInstances_EnableMonitoring.json +++ b/specification/hanaonazure/resource-manager/Microsoft.HanaOnAzure/preview/2017-11-03-preview/examples/HanaInstances_EnableMonitoring.json @@ -5,10 +5,9 @@ "resourceGroupName": "myResourceGroup", "hanaInstanceName": "myHanaInstance", "monitoringParameter": { - "hanaVnet": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVnet", + "hanaSubnet": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet", "hanaHostname": "hana.hostname", - "hanaInstanceNum": "04", - "dbContainer": "single", + "hanaDbSqlPort": 50, "hanaDbUsername": "SYSTEM", "hanaDbPassword": "passExample" } diff --git a/specification/hanaonazure/resource-manager/Microsoft.HanaOnAzure/preview/2017-11-03-preview/hanaonazure.json b/specification/hanaonazure/resource-manager/Microsoft.HanaOnAzure/preview/2017-11-03-preview/hanaonazure.json index 59bdc727c8fd..9e7c590364fd 100644 --- a/specification/hanaonazure/resource-manager/Microsoft.HanaOnAzure/preview/2017-11-03-preview/hanaonazure.json +++ b/specification/hanaonazure/resource-manager/Microsoft.HanaOnAzure/preview/2017-11-03-preview/hanaonazure.json @@ -671,34 +671,21 @@ "MonitoringDetails": { "type": "object", "properties": { - "hanaVnet": { + "hanaSubnet": { "type": "string", - "description": "ARM ID of an Azure Vnet with access to the HANA instance." + "description": "ARM ID of an Azure Subnet with access to the HANA instance." }, "hanaHostname": { "type": "string", "description": "Hostname of the HANA Instance blade." }, - "hanaInstanceNum": { + "hanaDbName": { "type": "string", - "description": "A number between 00 and 99, stored as a string to maintain leading zero." + "description": "Name of the database itself." }, - "dbContainer": { - "type": "string", - "enum": [ - "single", - "multiple" - ], - "default": "single", - "x-ms-enum": { - "name": "HanaDatabaseContainersEnum", - "modelAsString": true - }, - "description": "Either single or multiple depending on the use of MDC(Multiple Database Containers)" - }, - "hanaDatabase": { - "type": "string", - "description": "Name of the database itself. It only needs to be specified if using MDC" + "hanaDbSqlPort": { + "type": "integer", + "description": "The port number of the tenant DB. Used to connect to the DB." }, "hanaDbUsername": { "type": "string", diff --git a/specification/keyvault/resource-manager/readme.csharp.md b/specification/keyvault/resource-manager/readme.csharp.md index b4969a9b3819..81c0ba27aa11 100644 --- a/specification/keyvault/resource-manager/readme.csharp.md +++ b/specification/keyvault/resource-manager/readme.csharp.md @@ -29,6 +29,10 @@ batch: ApiVersionName: Api2016_10_01 ``` +### Profile: hybrid_2018_03_01 + +These settings apply only when `--profile=hybrid_2018_03_01` is specified on the command line. + ```yaml $(profile)=='hybrid_2018_03_01' namespace: Microsoft.Azure.Management.Profiles.$(profile).KeyVault output-folder: $(csharp-sdks-folder)/$(profile)/KeyVault/Management.KeyVault/Generated @@ -38,6 +42,10 @@ batch: - tag: package-2015-06 ``` +### Profile: profile_2017_03_09 + +These settings apply only when `--profile=profile_2017_03_09` is specified on the command line. + ``` yaml $(profile)=='profile_2017_03_09' namespace: Microsoft.Azure.Management.Profiles.$(profile).KeyVault output-folder: $(csharp-sdks-folder)/$(profile)/KeyVault/Management.KeyVault/Generated diff --git a/specification/managementpartner/resource-manager/Microsoft.ManagementPartner/preview/2018-02-01/ManagementPartner.json b/specification/managementpartner/resource-manager/Microsoft.ManagementPartner/preview/2018-02-01/ManagementPartner.json index a8a57ca441d8..f5a662148b4e 100644 --- a/specification/managementpartner/resource-manager/Microsoft.ManagementPartner/preview/2018-02-01/ManagementPartner.json +++ b/specification/managementpartner/resource-manager/Microsoft.ManagementPartner/preview/2018-02-01/ManagementPartner.json @@ -46,7 +46,7 @@ } ], "tags": [ - "partner" + "Partner" ], "responses": { "200": { @@ -81,7 +81,7 @@ } ], "tags": [ - "partner" + "Partner" ], "responses": { "200": { @@ -116,7 +116,7 @@ } ], "tags": [ - "partner" + "Partner" ], "responses": { "200": { @@ -151,7 +151,7 @@ } ], "tags": [ - "partner" + "Partner" ], "responses": { "200": { @@ -202,6 +202,40 @@ } } } + }, + "/providers/Microsoft.ManagementPartner/partners": { + "get": { + "summary": "Get a specific `Partner`.", + "description": "Get the management partner using the objectId and tenantId.", + "operationId": "Partners_Get", + "x-ms-examples": { + "GetPartnerDetails": { + "$ref": "./examples/GetPartnerDetailsNoPartnerId.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "tags": [ + "Partners" + ], + "responses": { + "200": { + "description": "Get the details of the `Partner`.", + "schema": { + "$ref": "#/definitions/PartnerResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + } + } } }, "definitions": { diff --git a/specification/managementpartner/resource-manager/Microsoft.ManagementPartner/preview/2018-02-01/examples/GetPartnerDetailsNoPartnerId.json b/specification/managementpartner/resource-manager/Microsoft.ManagementPartner/preview/2018-02-01/examples/GetPartnerDetailsNoPartnerId.json new file mode 100644 index 000000000000..a21b73660aa4 --- /dev/null +++ b/specification/managementpartner/resource-manager/Microsoft.ManagementPartner/preview/2018-02-01/examples/GetPartnerDetailsNoPartnerId.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2018-02-01" + }, + "responses": { + "200": { + "body": { + "id": "/providers/microsoft.managementpartner/partners", + "type": "Microsoft.ManagementPartner/partner", + "name": "123456", + "etag": 3, + "properties": { + "partnerId": "123456", + "partnerName": "Test_jefl", + "tenantId": "1b1121dd-6900-412a-af73-e8d44f81e1c1", + "objectId": "aa67f786-0552-423e-8849-244ed12bf581", + "version": "3", + "updatedTime": "2018-01-20T01:52:57.9126052Z", + "createdTime": "2018-01-20T01:23:40.5280496Z", + "state": "Active" + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2019-05-01/examples/Accounts_CreateOrUpdate.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2019-05-01/examples/Accounts_CreateOrUpdate.json new file mode 100644 index 000000000000..f7e8185facac --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2019-05-01/examples/Accounts_CreateOrUpdate.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "subscriptionId", + "resourceGroupName": "resourceGroup", + "accountName": "accountName", + "api-version": "2019-05-01", + "body": { + "location": "eastus" + } + }, + "responses": { + "200": { + "body": { + "location": "eastus", + "properties": { + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "location": "eastus", + "properties": { + "provisioningState": "Succeeded" + } + } + }, + "202": {} + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2019-05-01/examples/Accounts_Delete.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2019-05-01/examples/Accounts_Delete.json new file mode 100644 index 000000000000..8968a51a5a99 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2019-05-01/examples/Accounts_Delete.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "subscriptionId": "subscriptionId", + "resourceGroupName": "resourceGroup", + "accountName": "accountName", + "api-version": "2019-05-01" + }, + "responses": { + "204": {}, + "202": {} + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2019-05-01/examples/Accounts_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2019-05-01/examples/Accounts_Get.json new file mode 100644 index 000000000000..09d61b067dc0 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2019-05-01/examples/Accounts_Get.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "subscriptionId", + "resourceGroupName": "resourceGroup", + "accountName": "accountName", + "api-version": "2019-05-01" + }, + "responses": { + "200": { + "body": { + "location": "eastus", + "properties": { + "provisioningState": "Created" + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2019-05-01/examples/Accounts_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2019-05-01/examples/Accounts_List.json new file mode 100644 index 000000000000..4c8836049b95 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2019-05-01/examples/Accounts_List.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "subscriptionId", + "resourceGroupName": "resourceGroup", + "api-version": "2019-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "location": "eastus", + "properties": { + "provisioningState": "Created" + } + } + ] + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2019-05-01/examples/Accounts_Update.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2019-05-01/examples/Accounts_Update.json new file mode 100644 index 000000000000..29b8164674a9 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2019-05-01/examples/Accounts_Update.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "subscriptionId", + "resourceGroupName": "resourceGroup", + "accountName": "accountName", + "api-version": "2019-05-01", + "body": {} + }, + "responses": { + "200": { + "body": { + "location": "eastus", + "properties": { + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2019-05-01/examples/CheckFilePathAvailability.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2019-05-01/examples/CheckFilePathAvailability.json new file mode 100644 index 000000000000..cf432f1c14d7 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2019-05-01/examples/CheckFilePathAvailability.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "subscriptionId", + "location": "eastus", + "api-version": "2019-05-01", + "body": { + "name": "my-exact-filepth", + "type": "netAppAccount/capacityPools/volume", + "resourceGroup": "myrg" + } + }, + "responses": { + "200": { + "body": { + "isAvailable": true + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2019-05-01/examples/CheckNameAvailability.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2019-05-01/examples/CheckNameAvailability.json new file mode 100644 index 000000000000..05afbf0db5d4 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2019-05-01/examples/CheckNameAvailability.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "subscriptionId", + "location": "eastus", + "api-version": "2019-05-01", + "body": { + "name": "accName", + "type": "netAppAccount", + "resourceGroup": "myrg" + } + }, + "responses": { + "200": { + "body": { + "isAvailable": true + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2019-05-01/examples/MountTargets_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2019-05-01/examples/MountTargets_List.json new file mode 100644 index 000000000000..f3ee2188744e --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2019-05-01/examples/MountTargets_List.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "subscriptionId", + "resourceGroupName": "resourceGroup", + "accountName": "accountName", + "poolName": "poolName", + "volumeName": "volumeName", + "api-version": "2019-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "location": "eastus", + "properties": { + "endIp": "1.2.3.4", + "mountTargetId": "9760acf5-4638-11e7-9bdb-020073ca3333", + "startIp": "1.2.3.4", + "fileSystemId": "9760acf5-4638-11e7-9bdb-020073ca3333", + "subnet": "1.2.3.4", + "netmask": "255.255.255.0", + "ipAddress": "1.2.3.4", + "gateway": "1.2.3.4", + "smbServerFqdn": "fullyqualified.domainname.com", + "provisioningState": "Created" + } + } + ] + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2019-05-01/examples/Pools_CreateOrUpdate.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2019-05-01/examples/Pools_CreateOrUpdate.json new file mode 100644 index 000000000000..85723dc2317f --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2019-05-01/examples/Pools_CreateOrUpdate.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "subscriptionId", + "resourceGroupName": "resourceGroup", + "accountName": "accountName", + "poolName": "poolName", + "api-version": "2019-05-01", + "body": { + "location": "eastus", + "properties": { + "serviceLevel": "Premium" + } + } + }, + "responses": { + "200": { + "body": { + "location": "eastus", + "properties": { + "provisioningState": "Created", + "poolId": "9760acf5-4638-11e7-9bdb-020073ca7778", + "serviceLevel": "Premium", + "size": 4398046511104 + } + } + }, + "201": { + "body": { + "location": "eastus", + "properties": { + "provisioningState": "Created", + "poolId": "9760acf5-4638-11e7-9bdb-020073ca7778", + "serviceLevel": "Premium", + "size": 4398046511104 + } + } + }, + "202": {} + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2019-05-01/examples/Pools_Delete.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2019-05-01/examples/Pools_Delete.json new file mode 100644 index 000000000000..949559f94709 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2019-05-01/examples/Pools_Delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "subscriptionId", + "resourceGroupName": "resourceGroup", + "accountName": "accountName", + "poolName": "poolName", + "api-version": "2019-05-01" + }, + "responses": { + "204": {}, + "202": {} + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2019-05-01/examples/Pools_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2019-05-01/examples/Pools_Get.json new file mode 100644 index 000000000000..a0994c4c9805 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2019-05-01/examples/Pools_Get.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "subscriptionId", + "resourceGroupName": "resourceGroup", + "accountName": "accountName", + "poolName": "poolName", + "api-version": "2019-05-01" + }, + "responses": { + "200": { + "body": { + "location": "eastus", + "properties": { + "provisioningState": "Created", + "poolId": "9760acf5-4638-11e7-9bdb-020073ca7778", + "serviceLevel": "Premium", + "size": 4398046511104 + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2019-05-01/examples/Pools_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2019-05-01/examples/Pools_List.json new file mode 100644 index 000000000000..101578bc6c93 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2019-05-01/examples/Pools_List.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "subscriptionId", + "resourceGroupName": "resourceGroup", + "accountName": "accountName", + "api-version": "2019-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "location": "eastus", + "properties": { + "provisioningState": "Created", + "poolId": "9760acf5-4638-11e7-9bdb-020073ca7778", + "serviceLevel": "Premium", + "size": 4398046511104 + } + } + ] + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2019-05-01/examples/Pools_Update.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2019-05-01/examples/Pools_Update.json new file mode 100644 index 000000000000..652a9b5f55a5 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2019-05-01/examples/Pools_Update.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "subscriptionId": "subscriptionId", + "resourceGroupName": "resourceGroup", + "accountName": "accountName", + "poolName": "poolName", + "api-version": "2019-05-01", + "body": {} + }, + "responses": { + "200": { + "body": { + "location": "eastus", + "properties": { + "provisioningState": "Created", + "poolId": "9760acf5-4638-11e7-9bdb-020073ca7778", + "serviceLevel": "Premium", + "size": 4398046511104 + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2019-05-01/examples/Snapshots_Create.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2019-05-01/examples/Snapshots_Create.json new file mode 100644 index 000000000000..19a57beace0a --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2019-05-01/examples/Snapshots_Create.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "subscriptionId", + "resourceGroupName": "resourceGroup", + "accountName": "accountName", + "poolName": "poolName", + "volumeName": "volumeName", + "snapshotName": "snapshotName", + "api-version": "2019-05-01", + "body": { + "location": "eastus" + } + }, + "responses": { + "201": { + "body": { + "location": "eastus", + "properties": { + "snapshotId": "9760acf5-4638-11e7-9bdb-020073ca3333", + "fileSystemId": "9760acf5-4638-11e7-9bdb-020073ca3333", + "creationDate": "2017-08-15T13:23:33Z", + "provisioningState": "Created" + } + } + }, + "202": {} + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2019-05-01/examples/Snapshots_Delete.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2019-05-01/examples/Snapshots_Delete.json new file mode 100644 index 000000000000..b6f87582dda5 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2019-05-01/examples/Snapshots_Delete.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "subscriptionId": "subscriptionId", + "resourceGroupName": "resourceGroup", + "accountName": "accountName", + "poolName": "poolName", + "volumeName": "volumeName", + "snapshotName": "snapshotName", + "api-version": "2019-05-01" + }, + "responses": { + "204": {}, + "202": {}, + "200": {} + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2019-05-01/examples/Snapshots_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2019-05-01/examples/Snapshots_Get.json new file mode 100644 index 000000000000..762f230637d1 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2019-05-01/examples/Snapshots_Get.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "subscriptionId", + "resourceGroupName": "resourceGroup", + "accountName": "accountName", + "poolName": "poolName", + "volumeName": "volumeName", + "snapshotName": "snapshotName", + "api-version": "2019-05-01" + }, + "responses": { + "200": { + "body": { + "location": "eastus", + "properties": { + "snapshotId": "9760acf5-4638-11e7-9bdb-020073ca3333", + "fileSystemId": "9760acf5-4638-11e7-9bdb-020073ca3333", + "creationDate": "2017-08-15T13:23:33Z", + "provisioningState": "Created" + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2019-05-01/examples/Snapshots_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2019-05-01/examples/Snapshots_List.json new file mode 100644 index 000000000000..5bf9ef6dbc3e --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2019-05-01/examples/Snapshots_List.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "subscriptionId", + "resourceGroupName": "resourceGroup", + "accountName": "accountName", + "poolName": "poolName", + "volumeName": "volumeName", + "api-version": "2019-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "location": "eastus", + "properties": { + "snapshotId": "9760acf5-4638-11e7-9bdb-020073ca3333", + "fileSystemId": "9760acf5-4638-11e7-9bdb-020073ca3333", + "creationDate": "2017-08-15T13:23:33Z", + "provisioningState": "Created" + } + } + ] + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2019-05-01/examples/Snapshots_Update.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2019-05-01/examples/Snapshots_Update.json new file mode 100644 index 000000000000..b19678263d47 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2019-05-01/examples/Snapshots_Update.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "subscriptionId", + "resourceGroupName": "resourceGroup", + "accountName": "accountName", + "poolName": "poolName", + "volumeName": "volumeName", + "snapshotName": "snapshotName", + "api-version": "2019-05-01", + "body": {} + }, + "responses": { + "200": { + "body": { + "location": "eastus", + "properties": { + "snapshotId": "9760acf5-4638-11e7-9bdb-020073ca3333", + "fileSystemId": "9760acf5-4638-11e7-9bdb-020073ca3333", + "creationDate": "2017-08-15T13:23:33Z", + "provisioningState": "Created" + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2019-05-01/examples/Volumes_CreateOrUpdate.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2019-05-01/examples/Volumes_CreateOrUpdate.json new file mode 100644 index 000000000000..73ac4e7d7493 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2019-05-01/examples/Volumes_CreateOrUpdate.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "subscriptionId": "subscriptionId", + "resourceGroupName": "resourceGroup", + "accountName": "accountName", + "poolName": "poolName", + "volumeName": "volumeName", + "api-version": "2019-05-01", + "body": { + "location": "eastus", + "properties": { + "serviceLevel": "Premium", + "creationToken": "my-unique-file-path" + } + } + }, + "responses": { + "200": { + "body": { + "location": "eastus", + "properties": { + "fileSystemId": "9760acf5-4638-11e7-9bdb-020073ca7778", + "creationToken": "some-amazing-filepath", + "usageThreshold": 107374182400, + "serviceLevel": "Premium", + "provisioningState": "Created", + "subnetId": "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3" + } + } + }, + "201": { + "body": { + "location": "eastus", + "properties": { + "fileSystemId": "9760acf5-4638-11e7-9bdb-020073ca7778", + "creationToken": "some-amazing-filepath", + "usageThreshold": 107374182400, + "serviceLevel": "Premium", + "provisioningState": "Created", + "subnetId": "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3" + } + } + }, + "202": {} + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2019-05-01/examples/Volumes_Delete.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2019-05-01/examples/Volumes_Delete.json new file mode 100644 index 000000000000..c497f27bf6e8 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2019-05-01/examples/Volumes_Delete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "subscriptionId": "subscriptionId", + "resourceGroupName": "resourceGroup", + "accountName": "accountName", + "poolName": "poolName", + "volumeName": "volumeName", + "api-version": "2019-05-01" + }, + "responses": { + "204": {}, + "202": {} + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2019-05-01/examples/Volumes_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2019-05-01/examples/Volumes_Get.json new file mode 100644 index 000000000000..fb6864c7e431 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2019-05-01/examples/Volumes_Get.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "subscriptionId", + "resourceGroupName": "resourceGroup", + "accountName": "accountName", + "poolName": "poolName", + "volumeName": "volumeName", + "api-version": "2019-05-01" + }, + "responses": { + "200": { + "body": { + "location": "eastus", + "properties": { + "fileSystemId": "9760acf5-4638-11e7-9bdb-020073ca7778", + "creationToken": "some-amazing-filepath", + "usageThreshold": 107374182400, + "serviceLevel": "Premium", + "provisioningState": "Created", + "subnetId": "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3" + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2019-05-01/examples/Volumes_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2019-05-01/examples/Volumes_List.json new file mode 100644 index 000000000000..e707fe00a83d --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2019-05-01/examples/Volumes_List.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "subscriptionId", + "resourceGroupName": "resourceGroup", + "accountName": "accountName", + "poolName": "poolName", + "api-version": "2019-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "location": "eastus", + "properties": { + "fileSystemId": "9760acf5-4638-11e7-9bdb-020073ca7778", + "creationToken": "some-amazing-filepath", + "usageThreshold": 107374182400, + "serviceLevel": "Premium", + "provisioningState": "Created", + "subnetId": "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3" + } + } + ] + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2019-05-01/examples/Volumes_Update.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2019-05-01/examples/Volumes_Update.json new file mode 100644 index 000000000000..edd7eb6daebf --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2019-05-01/examples/Volumes_Update.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "subscriptionId", + "resourceGroupName": "resourceGroup", + "accountName": "accountName", + "poolName": "poolName", + "volumeName": "volumeName", + "api-version": "2019-05-01", + "body": {} + }, + "responses": { + "200": { + "body": { + "location": "eastus", + "properties": { + "fileSystemId": "9760acf5-4638-11e7-9bdb-020073ca7778", + "creationToken": "some-amazing-filepath", + "usageThreshold": 107374182400, + "serviceLevel": "Premium", + "provisioningState": "Created" + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2019-05-01/netapp.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2019-05-01/netapp.json new file mode 100644 index 000000000000..0d8707a75809 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2019-05-01/netapp.json @@ -0,0 +1,2117 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft NetApp", + "description": "Microsoft NetApp Azure Resource Provider specification", + "version": "2019-05-01", + "x-ms-code-generation-settings": { + "name": "AzureNetAppFilesManagementClient" + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "schemes": [ + "https" + ], + "host": "management.azure.com", + "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.NetApp/operations": { + "get": { + "tags": [ + "Operations" + ], + "summary": "Describes the Resource Provider", + "description": "Lists all of the available Microsoft.NetApp Rest API operations", + "operationId": "Operations_List", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-pageable": { + "nextLinkName": null + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed." + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.NetApp/locations/{location}/checkNameAvailability": { + "parameters": [ + { + "name": "body", + "in": "body", + "description": "Name availability request.", + "required": true, + "schema": { + "$ref": "#/definitions/ResourceNameAvailabilityRequest" + }, + "x-ms-client-flatten": true + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/location" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "post": { + "summary": "Check resource name availability", + "description": "Check if a resource name is available.", + "operationId": "CheckNameAvailability", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResourceNameAvailability" + } + }, + "default": { + "description": "Error response describing why the operation failed." + } + }, + "x-ms-examples": { + "CheckNameAvailability": { + "$ref": "examples/CheckNameAvailability.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.NetApp/locations/{location}/checkFilePathAvailability": { + "parameters": [ + { + "name": "body", + "in": "body", + "description": "File path availability request.", + "required": true, + "schema": { + "$ref": "#/definitions/ResourceNameAvailabilityRequest" + }, + "x-ms-client-flatten": true + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/location" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "post": { + "summary": "Check file path availability", + "description": "Check if a file path is available.", + "operationId": "CheckFilePathAvailability", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResourceNameAvailability" + } + }, + "default": { + "description": "Error response describing why the operation failed." + } + }, + "x-ms-examples": { + "CheckFilePathAvailability": { + "$ref": "examples/CheckFilePathAvailability.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts": { + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroup" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "get": { + "summary": "Describe all NetApp Accounts in a resource group", + "description": "List and describe all NetApp accounts in the resource group", + "tags": [ + "NetApp Accounts" + ], + "operationId": "Accounts_List", + "x-ms-pageable": { + "nextLinkName": null + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/netAppAccountList" + } + }, + "default": { + "description": "Error response describing why the operation failed." + } + }, + "x-ms-examples": { + "Accounts_List": { + "$ref": "examples/Accounts_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}": { + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroup" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "get": { + "summary": "Describe a NetApp Account", + "description": "Get the NetApp account", + "tags": [ + "NetApp Accounts" + ], + "operationId": "Accounts_Get", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/netAppAccount" + } + }, + "default": { + "description": "Error response describing why the operation failed." + } + }, + "x-ms-examples": { + "Accounts_Get": { + "$ref": "examples/Accounts_Get.json" + } + } + }, + "put": { + "tags": [ + "NetApp Accounts" + ], + "operationId": "Accounts_CreateOrUpdate", + "summary": "Create or update a NetApp account", + "description": "Create or update the specified NetApp account within the resource group", + "parameters": [ + { + "name": "body", + "description": "NetApp Account object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/netAppAccount" + } + } + ], + "responses": { + "200": { + "description": "OK - account updated", + "schema": { + "$ref": "#/definitions/netAppAccount" + } + }, + "201": { + "description": "Account created", + "schema": { + "$ref": "#/definitions/netAppAccount" + } + }, + "202": { + "description": "Accepted -- Create request accepted; operation will complete asynchronously" + }, + "default": { + "description": "Error response describing why the operation failed." + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Accounts_CreateOrUpdate": { + "$ref": "examples/Accounts_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "NetApp Accounts" + ], + "operationId": "Accounts_Delete", + "summary": "Delete a NetApp account", + "description": "Delete the specified NetApp account", + "responses": { + "202": { + "description": "Accepted -- Create or update request accepted; operation will complete asynchronously" + }, + "204": { + "description": "NoContent -- Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed." + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Accounts_Delete": { + "$ref": "examples/Accounts_Delete.json" + } + } + }, + "patch": { + "tags": [ + "NetApp Accounts" + ], + "operationId": "Accounts_Update", + "summary": "Update a NetApp account", + "description": "Patch the specified NetApp account", + "parameters": [ + { + "name": "body", + "description": "NetApp Account object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/netAppAccountPatch" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/netAppAccount" + } + }, + "default": { + "description": "Error response describing why the operation failed." + } + }, + "x-ms-examples": { + "Accounts_Update": { + "$ref": "examples/Accounts_Update.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools": { + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroup" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "get": { + "summary": "Describe all Capacity Pools", + "description": "List all capacity pools in the NetApp Account", + "tags": [ + "Capacity Pools" + ], + "operationId": "Pools_List", + "x-ms-pageable": { + "nextLinkName": null + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/capacityPoolList" + } + }, + "default": { + "description": "Error response describing why the operation failed." + } + }, + "x-ms-examples": { + "Pools_List": { + "$ref": "examples/Pools_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}": { + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroup" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "get": { + "summary": "Describe a Capacity Pool", + "description": "Get details of the specified capacity pool", + "tags": [ + "Capacity Pools" + ], + "operationId": "Pools_Get", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/capacityPool" + } + }, + "default": { + "description": "Error response describing why the operation failed." + } + }, + "x-ms-examples": { + "Pools_Get": { + "$ref": "examples/Pools_Get.json" + } + } + }, + "put": { + "tags": [ + "Capacity Pools" + ], + "operationId": "Pools_CreateOrUpdate", + "summary": "Create or Update the specified capacity pool within the resource group", + "description": "Create or Update a capacity pool", + "parameters": [ + { + "name": "body", + "description": "Capacity pool object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/capacityPool" + } + } + ], + "responses": { + "200": { + "description": "OK - pool updated", + "schema": { + "$ref": "#/definitions/capacityPool" + } + }, + "201": { + "description": "Pool created", + "schema": { + "$ref": "#/definitions/capacityPool" + } + }, + "202": { + "description": "Accepted -- Create request accepted; operation will complete asynchronously" + }, + "default": { + "description": "Error response describing why the operation failed." + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Pools_CreateOrUpdate": { + "$ref": "examples/Pools_CreateOrUpdate.json" + } + } + }, + "patch": { + "tags": [ + "Capacity Pools" + ], + "operationId": "Pools_Update", + "summary": "Update a capacity pool", + "description": "Patch the specified capacity pool", + "parameters": [ + { + "name": "body", + "description": "Capacity pool object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/capacityPoolPatch" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/capacityPool" + } + }, + "default": { + "description": "Error response describing why the operation failed." + } + }, + "x-ms-examples": { + "Pools_Update": { + "$ref": "examples/Pools_Update.json" + } + } + }, + "delete": { + "tags": [ + "Capacity Pools" + ], + "operationId": "Pools_Delete", + "summary": "Delete a capacity pool", + "description": "Delete the specified capacity pool", + "responses": { + "202": { + "description": "Accepted -- Create or update request accepted; operation will complete asynchronously" + }, + "204": { + "description": "NoContent -- Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed." + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Pools_Delete": { + "$ref": "examples/Pools_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes": { + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroup" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "get": { + "summary": "Describe all volumes", + "description": "List all volumes within the capacity pool", + "tags": [ + "Volumes" + ], + "operationId": "Volumes_List", + "x-ms-pageable": { + "nextLinkName": null + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/volumeList" + } + }, + "default": { + "description": "Error response describing why the operation failed." + } + }, + "x-ms-examples": { + "Volumes_List": { + "$ref": "examples/Volumes_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}": { + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroup" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "get": { + "tags": [ + "Volumes" + ], + "operationId": "Volumes_Get", + "summary": "Describe a volume", + "description": "Get the details of the specified volume", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/volume" + } + }, + "default": { + "description": "Error response describing why the operation failed." + } + }, + "x-ms-examples": { + "Volumes_Get": { + "$ref": "examples/Volumes_Get.json" + } + } + }, + "put": { + "tags": [ + "Volumes" + ], + "operationId": "Volumes_CreateOrUpdate", + "summary": "Create or Update a volume", + "description": "Create or update the specified volume within the capacity pool", + "parameters": [ + { + "name": "body", + "description": "Volume object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/volume" + } + } + ], + "responses": { + "200": { + "description": "Ok - volume updated", + "schema": { + "$ref": "#/definitions/volume" + } + }, + "201": { + "description": "Volume created", + "schema": { + "$ref": "#/definitions/volume" + } + }, + "202": { + "description": "Accepted -- Create request accepted; operation will complete asynchronously" + }, + "default": { + "description": "Error response describing why the operation failed." + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Volumes_CreateOrUpdate": { + "$ref": "examples/Volumes_CreateOrUpdate.json" + } + } + }, + "patch": { + "tags": [ + "Volumes" + ], + "operationId": "Volumes_Update", + "summary": "Update a volume", + "description": "Patch the specified volume", + "parameters": [ + { + "name": "body", + "description": "Volume object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/volumePatch" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/volume" + } + }, + "default": { + "description": "Error response describing why the operation failed." + } + }, + "x-ms-examples": { + "Volumes_Update": { + "$ref": "examples/Volumes_Update.json" + } + } + }, + "delete": { + "tags": [ + "Volumes" + ], + "operationId": "Volumes_Delete", + "summary": "Delete a volume", + "description": "Delete the specified volume", + "responses": { + "202": { + "description": "Accepted -- Create or update request accepted; operation will complete asynchronously" + }, + "204": { + "description": "NoContent -- Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed." + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Volumes_Delete": { + "$ref": "examples/Volumes_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/mountTargets": { + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroup" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "get": { + "tags": [ + "MountTargets" + ], + "operationId": "MountTargets_List", + "summary": "Describe all mount targets", + "description": "List all mount targets associated with the volume", + "x-ms-pageable": { + "nextLinkName": null + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/mountTargetList" + } + }, + "default": { + "description": "Error response describing why the operation failed." + } + }, + "x-ms-examples": { + "MountTargets_List": { + "$ref": "examples/MountTargets_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/snapshots": { + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroup" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "get": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_List", + "summary": "Describe all snapshots", + "description": "List all snapshots associated with the volume", + "x-ms-pageable": { + "nextLinkName": null + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/snapshotsList" + } + }, + "default": { + "description": "Error response describing why the operation failed." + } + }, + "x-ms-examples": { + "Snapshots_List": { + "$ref": "examples/Snapshots_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/snapshots/{snapshotName}": { + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroup" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "#/parameters/SnapshotName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "get": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_Get", + "summary": "Describe a snapshot", + "description": "Get details of the specified snapshot", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/snapshot" + } + }, + "default": { + "description": "Error response describing why the operation failed." + } + }, + "x-ms-examples": { + "Snapshots_Get": { + "$ref": "examples/Snapshots_Get.json" + } + } + }, + "put": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_Create", + "summary": "Create a snapshot", + "description": "Create the specified snapshot within the given volume", + "parameters": [ + { + "name": "body", + "description": "Snapshot object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/snapshot" + } + } + ], + "responses": { + "201": { + "description": "Snapshot created", + "schema": { + "$ref": "#/definitions/snapshot" + } + }, + "202": { + "description": "Accepted -- Create request accepted; operation will complete asynchronously" + }, + "default": { + "description": "Error response describing why the operation failed." + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Snapshots_Create": { + "$ref": "examples/Snapshots_Create.json" + } + } + }, + "patch": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_Update", + "summary": "Update a snapshot", + "description": "Patch a snapshot", + "parameters": [ + { + "name": "body", + "description": "Snapshot object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/snapshotPatch" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/snapshot" + } + }, + "default": { + "description": "Error response describing why the operation failed." + } + }, + "x-ms-examples": { + "Snapshots_Update": { + "$ref": "examples/Snapshots_Update.json" + } + } + }, + "delete": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_Delete", + "summary": "Delete a snapshot", + "description": "Delete snapshot", + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted -- Create or update request accepted; operation will complete asynchronously" + }, + "204": { + "description": "NoContent -- Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed." + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Snapshots_Delete": { + "$ref": "examples/Snapshots_Delete.json" + } + } + } + } + }, + "definitions": { + "OperationListResult": { + "description": "Result of the request to list Cloud Volume operations. It contains a list of operations and a URL link to get the next set of results.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + }, + "description": "List of Storage operations supported by the Storage resource provider." + } + } + }, + "Operation": { + "description": "Microsoft.NetApp REST API operation definition.", + "type": "object", + "properties": { + "name": { + "description": "Operation name: {provider}/{resource}/{operation}", + "type": "string" + }, + "display": { + "description": "Display metadata associated with the operation.", + "properties": { + "provider": { + "description": "Service provider: Microsoft NetApp.", + "type": "string" + }, + "resource": { + "description": "Resource on which the operation is performed etc.", + "type": "string" + }, + "operation": { + "description": "Type of operation: get, read, delete, etc.", + "type": "string" + }, + "description": { + "description": "Operation description.", + "type": "string" + } + } + }, + "origin": { + "type": "string", + "description": "The origin of operations." + }, + "properties": { + "$ref": "#/definitions/OperationProperties", + "description": "Properties of operation, include metric specifications.", + "x-ms-client-flatten": true + } + } + }, + "OperationProperties": { + "description": "Properties of operation, include metric specifications.", + "properties": { + "serviceSpecification": { + "$ref": "#/definitions/ServiceSpecification", + "description": "One property of operation, include metric specifications." + } + } + }, + "ServiceSpecification": { + "description": "One property of operation, include metric specifications.", + "properties": { + "metricSpecifications": { + "description": "Metric specifications of operation.", + "type": "array", + "items": { + "$ref": "#/definitions/MetricSpecification" + } + } + } + }, + "MetricSpecification": { + "description": "Metric specification of operation.", + "properties": { + "name": { + "type": "string", + "description": "Name of metric specification." + }, + "displayName": { + "type": "string", + "description": "Display name of metric specification." + }, + "displayDescription": { + "type": "string", + "description": "Display description of metric specification." + }, + "unit": { + "type": "string", + "description": "Unit could be Bytes or Count." + }, + "dimensions": { + "description": "Dimensions of blobs, including blob type and access tier.", + "type": "array", + "items": { + "$ref": "#/definitions/Dimension" + } + }, + "aggregationType": { + "type": "string", + "description": "Aggregation type could be Average." + }, + "fillGapWithZero": { + "type": "boolean", + "description": "The property to decide fill gap with zero or not." + }, + "category": { + "type": "string", + "description": "The category this metric specification belong to, could be Capacity." + }, + "resourceIdDimensionNameOverride": { + "type": "string", + "description": "Account Resource Id." + } + } + }, + "Dimension": { + "description": "Dimension of blobs, possibly be blob type or access tier.", + "properties": { + "name": { + "type": "string", + "description": "Display name of dimension." + }, + "displayName": { + "type": "string", + "description": "Display name of dimension." + } + } + }, + "ResourceNameAvailability": { + "description": "Information regarding availability of a resource name.", + "type": "object", + "properties": { + "isAvailable": { + "description": "true indicates name is valid and available. false indicates the name is invalid, unavailable, or both.", + "type": "boolean" + }, + "reason": { + "description": "Invalid indicates the name provided does not match Azure App Service naming requirements. AlreadyExists indicates that the name is already in use and is therefore unavailable.", + "enum": [ + "Invalid", + "AlreadyExists" + ], + "type": "string", + "x-ms-enum": { + "name": "InAvailabilityReasonType", + "modelAsString": true + } + }, + "message": { + "description": "If reason == invalid, provide the user with the reason why the given name is invalid, and provide the resource naming requirements so that the user can select a valid name. If reason == AlreadyExists, explain that resource name is already in use, and direct them to select a different name.", + "type": "string" + } + } + }, + "ResourceNameAvailabilityRequest": { + "description": "Resource name availability request content.", + "required": [ + "name", + "type", + "resourceGroup" + ], + "type": "object", + "properties": { + "name": { + "description": "Resource name to verify.", + "type": "string" + }, + "type": { + "description": "Resource type used for verification.", + "enum": [ + "Microsoft.NetApp/netAppAccount", + "Microsoft.NetApp/netAppAccount/capacityPools", + "Microsoft.NetApp/netAppAccount/capacityPools/volumes", + "Microsoft.NetApp/netAppAccount/capacityPools/volumes/snapshots" + ], + "type": "string", + "x-ms-enum": { + "name": "CheckNameResourceTypes", + "modelAsString": true + } + }, + "resourceGroup": { + "description": "Resource group name.", + "type": "string" + } + } + }, + "netAppAccountList": { + "description": "List of NetApp account resources", + "type": "object", + "properties": { + "value": { + "type": "array", + "description": "Multiple NetApp accounts", + "items": { + "$ref": "#/definitions/netAppAccount" + } + } + } + }, + "netAppAccount": { + "description": "NetApp account resource", + "type": "object", + "x-ms-azure-resource": true, + "required": [ + "location" + ], + "properties": { + "location": { + "type": "string", + "description": "Resource location", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "id": { + "type": "string", + "readOnly": true, + "description": "Resource Id" + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Resource name" + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Resource type" + }, + "tags": { + "description": "Resource tags", + "$ref": "#/definitions/resourceTags" + }, + "properties": { + "description": "NetApp Account properties", + "$ref": "#/definitions/accountProperties", + "x-ms-client-flatten": true + } + } + }, + "netAppAccountPatch": { + "description": "NetApp account patch resource", + "type": "object", + "x-ms-azure-resource": true, + "properties": { + "location": { + "type": "string", + "description": "Resource location" + }, + "id": { + "type": "string", + "readOnly": true, + "description": "Resource Id" + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Resource name" + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Resource type" + }, + "tags": { + "description": "Resource tags", + "$ref": "#/definitions/resourceTags" + }, + "properties": { + "description": "NetApp Account properties", + "$ref": "#/definitions/accountProperties", + "x-ms-client-flatten": true + } + } + }, + "accountProperties": { + "description": "NetApp account properties", + "type": "object", + "properties": { + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "Azure lifecycle management" + }, + "activeDirectories": { + "description": "Active Directories", + "type": "array", + "items": { + "$ref": "#/definitions/activeDirectory" + } + } + } + }, + "activeDirectory": { + "description": "Active Directory", + "type": "object", + "properties": { + "activeDirectoryId": { + "type": "string", + "description": "Id of the Active Directory" + }, + "username": { + "type": "string", + "description": "Username of Active Directory domain administrator" + }, + "password": { + "type": "string", + "description": "Plain text password of Active Directory domain administrator" + }, + "domain": { + "type": "string", + "description": "Name of the Active Directory domain" + }, + "dns": { + "type": "string", + "description": "Comma separated list of DNS server IP addresses for the Active Directory domain" + }, + "status": { + "type": "string", + "description": "Status of the Active Directory" + }, + "smbServerName": { + "type": "string", + "description": "NetBIOS name of the SMB server. This name will be registered as a computer account in the AD and used to mount volumes" + }, + "organizationalUnit": { + "type": "string", + "description": "The Organizational Unit (OU) within the Windows Active Directory" + } + } + }, + "capacityPoolList": { + "description": "List of capacity pool resources", + "type": "object", + "properties": { + "value": { + "description": "List of Capacity pools", + "type": "array", + "items": { + "$ref": "#/definitions/capacityPool" + } + } + } + }, + "capacityPool": { + "description": "Capacity pool resource", + "type": "object", + "x-ms-azure-resource": true, + "required": [ + "location", + "properties" + ], + "properties": { + "location": { + "type": "string", + "description": "Resource location", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "id": { + "type": "string", + "readOnly": true, + "description": "Resource Id" + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Resource name" + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Resource type" + }, + "tags": { + "description": "Resource tags", + "$ref": "#/definitions/resourceTags" + }, + "properties": { + "description": "Capacity pool properties", + "$ref": "#/definitions/poolProperties", + "x-ms-client-flatten": true + } + } + }, + "poolProperties": { + "description": "Pool properties", + "type": "object", + "properties": { + "poolId": { + "title": "poolId", + "type": "string", + "readOnly": true, + "description": "UUID v4 used to identify the Pool", + "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$", + "maxLength": 36, + "minLength": 36, + "example": "9760acf5-4638-11e7-9bdb-020073ca7778" + }, + "size": { + "title": "size", + "type": "integer", + "format": "int64", + "description": "Provisioned size of the pool (in bytes). Allowed values are in 4TiB chunks (value must be multiply of 4398046511104).", + "minimum": 4398046511104, + "maximum": 549755813888000, + "default": 4398046511104 + }, + "serviceLevel": { + "title": "serviceLevel", + "type": "string", + "description": "The service level of the file system", + "enum": [ + "Standard", + "Premium", + "Ultra" + ], + "x-ms-enum": { + "name": "ServiceLevel", + "modelAsString": true, + "values": [ + { + "value": "Standard", + "description": "Standard service level" + }, + { + "value": "Premium", + "description": "Premium service level" + }, + { + "value": "Ultra", + "description": "Ultra service level" + } + ] + }, + "example": "Ultra", + "default": "Premium" + }, + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "Azure lifecycle management" + } + } + }, + "capacityPoolPatch": { + "description": "Capacity pool patch resource", + "type": "object", + "x-ms-azure-resource": true, + "properties": { + "location": { + "type": "string", + "description": "Resource location" + }, + "id": { + "type": "string", + "readOnly": true, + "description": "Resource Id" + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Resource name" + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Resource type" + }, + "tags": { + "description": "Resource tags", + "$ref": "#/definitions/resourceTags" + }, + "properties": { + "description": "Capacity pool properties", + "$ref": "#/definitions/poolPatchProperties", + "x-ms-client-flatten": true + } + } + }, + "poolPatchProperties": { + "description": "Patchable pool properties", + "type": "object", + "properties": { + "size": { + "title": "size", + "type": "integer", + "format": "int64", + "description": "Provisioned size of the pool (in bytes). Allowed values are in 4TiB chunks (value must be multiply of 4398046511104).", + "minimum": 4398046511104, + "maximum": 549755813888000, + "default": 4398046511104 + }, + "serviceLevel": { + "title": "serviceLevel", + "type": "string", + "description": "The service level of the file system", + "enum": [ + "Standard", + "Premium", + "Ultra" + ], + "x-ms-enum": { + "name": "ServiceLevel", + "modelAsString": true, + "values": [ + { + "value": "Standard", + "description": "Standard service level" + }, + { + "value": "Premium", + "description": "Premium service level" + }, + { + "value": "Ultra", + "description": "Ultra service level" + } + ] + }, + "example": "Ultra", + "default": "Premium" + } + } + }, + "volumeList": { + "description": "List of volume resources", + "type": "object", + "properties": { + "value": { + "description": "List of volumes", + "type": "array", + "items": { + "$ref": "#/definitions/volume" + } + } + } + }, + "volume": { + "description": "Volume resource", + "type": "object", + "x-ms-azure-resource": true, + "required": [ + "location", + "properties" + ], + "properties": { + "location": { + "type": "string", + "description": "Resource location", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "id": { + "type": "string", + "readOnly": true, + "description": "Resource Id" + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Resource name" + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Resource type" + }, + "tags": { + "description": "Resource tags", + "$ref": "#/definitions/resourceTags" + }, + "properties": { + "description": "Volume properties", + "$ref": "#/definitions/volumeProperties", + "x-ms-client-flatten": true + } + } + }, + "resourceTags": { + "description": "Resource tags", + "type": "object" + }, + "volumeProperties": { + "description": "Volume properties", + "type": "object", + "required": [ + "creationToken", + "serviceLevel" + ], + "properties": { + "fileSystemId": { + "title": "FileSystem ID", + "type": "string", + "readOnly": true, + "description": "Unique FileSystem Identifier.", + "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$", + "maxLength": 36, + "minLength": 36, + "example": "9760acf5-4638-11e7-9bdb-020073ca7778" + }, + "creationToken": { + "title": "Creation Token or File Path", + "type": "string", + "description": "A unique file path for the volume. Used when creating mount targets", + "minimum": 16, + "maximum": 40, + "example": "some-amazing-filepath" + }, + "serviceLevel": { + "title": "serviceLevel", + "type": "string", + "description": "The service level of the file system", + "enum": [ + "Standard", + "Premium", + "Ultra" + ], + "x-ms-enum": { + "name": "ServiceLevel", + "modelAsString": true, + "values": [ + { + "value": "Standard", + "description": "Standard service level" + }, + { + "value": "Premium", + "description": "Premium service level" + }, + { + "value": "Ultra", + "description": "Ultra service level" + } + ] + }, + "example": "Ultra", + "default": "Premium" + }, + "usageThreshold": { + "title": "usageThreshold", + "type": "integer", + "format": "int64", + "description": "Maximum storage quota allowed for a file system in bytes. This is a soft quota used for alerting only. Minimum size is 100 GiB. Upper limit is 100TiB.", + "minimum": 107374182400, + "maximum": 109951162777600, + "default": 107374182400, + "example": 107374182400 + }, + "exportPolicy": { + "title": "exportPolicy", + "description": "Set of export policy rules", + "properties": { + "rules": { + "title": "Export policy rule", + "description": "Export policy rule", + "type": "array", + "items": { + "$ref": "#/definitions/exportPolicyRule" + } + } + } + }, + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "Azure lifecycle management" + }, + "snapshotId": { + "title": "Snapshot ID", + "type": "string", + "description": "UUID v4 used to identify the Snapshot", + "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$", + "maxLength": 36, + "minLength": 36, + "example": "9760acf5-4638-11e7-9bdb-020073ca3333" + }, + "baremetalTenantId": { + "title": "Baremetal Tenant ID", + "type": "string", + "readOnly": true, + "description": "Unique Baremetal Tenant Identifier.", + "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$", + "maxLength": 36, + "minLength": 36, + "example": "9560acf5-4e3a-12e7-9bdb-02007cca7779" + }, + "subnetId": { + "type": "string", + "description": "The Azure Resource URI for a delegated subnet. Must have the delegation Microsoft.NetApp/volumes" + } + } + }, + "exportPolicyRule": { + "description": "Volume Export Policy Rule", + "type": "object", + "properties": { + "ruleIndex": { + "type": "integer", + "description": "Order index" + }, + "unixReadOnly": { + "type": "boolean", + "description": "Read only access" + }, + "unixReadWrite": { + "type": "boolean", + "description": "Read and write access" + }, + "cifs": { + "type": "boolean", + "description": "Allows CIFS protocol" + }, + "nfsv3": { + "type": "boolean", + "description": "Allows NFSv3 protocol" + }, + "nfsv4": { + "type": "boolean", + "description": "Allows NFSv4 protocol" + }, + "allowedClients": { + "type": "string", + "description": "Client ingress specification as comma separated string with IPv4 CIDRs, IPv4 host addresses and host names" + } + } + }, + "volumePatch": { + "description": "Volume patch resource", + "type": "object", + "x-ms-azure-resource": true, + "properties": { + "location": { + "type": "string", + "description": "Resource location" + }, + "id": { + "type": "string", + "readOnly": true, + "description": "Resource Id" + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Resource name" + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Resource type" + }, + "tags": { + "description": "Resource tags", + "$ref": "#/definitions/resourceTags" + }, + "properties": { + "description": "Patchable volume properties", + "$ref": "#/definitions/volumePatchProperties", + "x-ms-client-flatten": true + } + } + }, + "volumePatchProperties": { + "description": "Patchable volume properties", + "type": "object", + "properties": { + "serviceLevel": { + "title": "serviceLevel", + "type": "string", + "description": "The service level of the file system", + "enum": [ + "Standard", + "Premium", + "Ultra" + ], + "x-ms-enum": { + "name": "ServiceLevel", + "modelAsString": true, + "values": [ + { + "value": "Standard", + "description": "Standard service level" + }, + { + "value": "Premium", + "description": "Premium service level" + }, + { + "value": "Ultra", + "description": "Ultra service level" + } + ] + }, + "example": "Ultra", + "default": "Premium" + }, + "usageThreshold": { + "title": "usageThreshold", + "type": "integer", + "format": "int64", + "description": "Maximum storage quota allowed for a file system in bytes. This is a soft quota used for alerting only. Minimum size is 100 GiB. Upper limit is 100TiB.", + "minimum": 107374182400, + "maximum": 109951162777600, + "default": 107374182400, + "example": 107374182400 + }, + "exportPolicy": { + "title": "exportPolicy", + "description": "Set of export policy rules", + "properties": { + "rules": { + "title": "Export policy rule", + "description": "Export policy rule", + "type": "array", + "items": { + "$ref": "#/definitions/exportPolicyRule" + } + } + } + } + } + }, + "mountTargetList": { + "description": "List of Mount Targets", + "type": "object", + "properties": { + "value": { + "description": "A list of Mount targets", + "type": "array", + "items": { + "$ref": "#/definitions/mountTarget" + } + } + } + }, + "mountTarget": { + "description": "Mount Target", + "type": "object", + "required": [ + "location", + "properties" + ], + "properties": { + "location": { + "type": "string", + "description": "Resource location" + }, + "id": { + "type": "string", + "readOnly": true, + "description": "Resource Id" + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Resource name" + }, + "tags": { + "description": "Resource tags", + "$ref": "#/definitions/resourceTags", + "x-ms-client-flatten": true + }, + "properties": { + "description": "Mount Target Properties", + "$ref": "#/definitions/mountTargetProperties", + "x-ms-client-flatten": true + } + } + }, + "mountTargetProperties": { + "description": "Mount target properties", + "type": "object", + "required": [ + "fileSystemId" + ], + "properties": { + "mountTargetId": { + "title": "mountTargetId", + "type": "string", + "readOnly": true, + "description": "UUID v4 used to identify the MountTarget", + "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$", + "maxLength": 36, + "minLength": 36, + "example": "9760acf5-4638-11e7-9bdb-020073ca3333" + }, + "fileSystemId": { + "title": "fileSystemId", + "type": "string", + "description": "UUID v4 used to identify the MountTarget", + "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$", + "maxLength": 36, + "minLength": 36, + "example": "9760acf5-4638-11e7-9bdb-020073ca3333" + }, + "ipAddress": { + "title": "ipAddress", + "description": "The mount target's IPv4 address", + "type": "string", + "readOnly": true, + "example": "1.2.3.4" + }, + "subnet": { + "title": "subnet", + "type": "string", + "description": "The subnet", + "example": "1.2.3.4" + }, + "startIp": { + "title": "startIp", + "description": "The start of IPv4 address range to use when creating a new mount target", + "type": "string", + "example": "1.2.3.4" + }, + "endIp": { + "title": "endIp", + "description": "The end of IPv4 address range to use when creating a new mount target", + "type": "string", + "example": "1.2.3.4" + }, + "gateway": { + "title": "gateway", + "description": "The gateway of the IPv4 address range to use when creating a new mount target", + "type": "string", + "example": "1.2.3.4" + }, + "netmask": { + "title": "netmask", + "description": "The netmask of the IPv4 address range to use when creating a new mount target", + "type": "string", + "example": "255.255.255.0" + }, + "smbServerFqdn": { + "title": "smbServerFQDN", + "description": "The SMB server's Fully Qualified Domain Name, FQDN", + "type": "string", + "example": "fullyqualified.domainname.com" + }, + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "Azure lifecycle management" + } + } + }, + "snapshotsList": { + "description": "List of Snapshots", + "type": "object", + "properties": { + "value": { + "description": "A list of Snapshots", + "type": "array", + "items": { + "$ref": "#/definitions/snapshot" + } + } + } + }, + "snapshot": { + "description": "Snapshot of a Volume", + "type": "object", + "x-ms-azure-resource": true, + "required": [ + "location" + ], + "properties": { + "location": { + "type": "string", + "description": "Resource location", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "id": { + "type": "string", + "readOnly": true, + "description": "Resource Id" + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Resource name" + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Resource type" + }, + "tags": { + "description": "Resource tags", + "$ref": "#/definitions/resourceTags", + "x-ms-client-flatten": true + }, + "properties": { + "description": "Snapshot Properties", + "$ref": "#/definitions/snapshotProperties", + "x-ms-client-flatten": true + } + } + }, + "snapshotPatch": { + "description": "Snapshot patch", + "type": "object", + "x-ms-azure-resource": true, + "properties": { + "tags": { + "description": "Resource tags", + "$ref": "#/definitions/resourceTags", + "x-ms-client-flatten": true + } + } + }, + "snapshotProperties": { + "description": "Snapshot properties", + "type": "object", + "properties": { + "snapshotId": { + "title": "snapshotId", + "type": "string", + "readOnly": true, + "description": "UUID v4 used to identify the Snapshot", + "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$", + "maxLength": 36, + "minLength": 36, + "example": "9760acf5-4638-11e7-9bdb-020073ca3333" + }, + "fileSystemId": { + "title": "fileSystemId", + "type": "string", + "description": "UUID v4 used to identify the FileSystem", + "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$", + "maxLength": 36, + "minLength": 36, + "example": "9760acf5-4638-11e7-9bdb-020073ca3333" + }, + "creationDate": { + "title": "name", + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "The creation date of the snapshot", + "example": "2017-08-15 13:23:33" + }, + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "Azure lifecycle management" + } + } + } + }, + "parameters": { + "SubscriptionId": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." + }, + "location": { + "name": "location", + "description": "The location", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ResourceGroup": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group.", + "pattern": "^[-\\w\\._\\(\\)]+$", + "minLength": 1, + "maxLength": 90, + "x-ms-parameter-location": "method" + }, + "AccountName": { + "name": "accountName", + "type": "string", + "in": "path", + "required": true, + "description": "The name of the NetApp account", + "x-ms-parameter-location": "method" + }, + "PoolName": { + "name": "poolName", + "type": "string", + "in": "path", + "required": true, + "description": "The name of the capacity pool", + "x-ms-parameter-location": "method" + }, + "VolumeName": { + "name": "volumeName", + "type": "string", + "in": "path", + "required": true, + "description": "The name of the volume", + "x-ms-parameter-location": "method" + }, + "MountTargetName": { + "name": "mountTargetName", + "type": "string", + "in": "path", + "required": true, + "description": "The name of the mount target", + "x-ms-parameter-location": "method" + }, + "SnapshotName": { + "name": "snapshotName", + "type": "string", + "in": "path", + "required": true, + "description": "The name of the mount target", + "x-ms-parameter-location": "method" + }, + "ApiVersionParameter": { + "name": "api-version", + "description": "Version of the API to be used with the client request.", + "in": "query", + "type": "string", + "required": true, + "default": "2017-08-15" + } + } +} \ No newline at end of file diff --git a/specification/netapp/resource-manager/readme.csharp.md b/specification/netapp/resource-manager/readme.csharp.md index bb032c0b2210..50a0e20bf93a 100644 --- a/specification/netapp/resource-manager/readme.csharp.md +++ b/specification/netapp/resource-manager/readme.csharp.md @@ -8,7 +8,7 @@ csharp: # last generated with AutoRest.0.17.3 azure-arm: true license-header: MICROSOFT_MIT_NO_VERSION - namespace: Microsoft.NetApp + namespace: Microsoft.Azure.Management.NetApp output-folder: $(csharp-sdks-folder)/NetApp/Management.NetApp/Generated clear-output-folder: true ``` diff --git a/specification/netapp/resource-manager/readme.go.md b/specification/netapp/resource-manager/readme.go.md index b5c4dc5b8812..6d3fca2efc9f 100644 --- a/specification/netapp/resource-manager/readme.go.md +++ b/specification/netapp/resource-manager/readme.go.md @@ -13,9 +13,19 @@ go: ``` yaml $(go) && $(multiapi) batch: + - tag: package-netapp-2019-05-01 - tag: package-2017-08-15 ``` +### Tag: package-netapp-2019-05-01 and go + +These settings apply only when `--tag=package-netapp-2019-05-01 --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-netapp-2019-05-01' && $(go) +output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2019-05-01/$(namespace) +``` + ### Tag: package-2017-08-15 and go These settings apply only when `--tag=package-2017-08-15 --go` is specified on the command line. diff --git a/specification/netapp/resource-manager/readme.md b/specification/netapp/resource-manager/readme.md index fb18b5f1d4a3..324c8442f242 100644 --- a/specification/netapp/resource-manager/readme.md +++ b/specification/netapp/resource-manager/readme.md @@ -25,11 +25,22 @@ To see additional help and options, run: These are the global settings for the Azure NetApp Files API. ``` yaml +title: NetAppManagementClient +description: Microsoft NetApp Azure Resource Provider specification openapi-type: arm -tag: package-2017-08-15 +tag: package-netapp-2019-05-01 ``` +### Tag: package-netapp-2019-05-01 + +These settings apply only when `--tag=package-netapp-2019-05-01` is specified on the command line. + +``` yaml $(tag) == 'package-netapp-2019-05-01' +input-file: +- Microsoft.NetApp/stable/2019-05-01/netapp.json +``` + ### Tag: package-2017-08-15 These settings apply only when `--tag=package-2017-08-15` is specified on the command line. diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-02-01/availableDelegations.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-02-01/availableDelegations.json index 4596f2408be0..c867a45443bc 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-02-01/availableDelegations.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-02-01/availableDelegations.json @@ -1,166 +1,166 @@ -{ - "swagger": "2.0", - "info": { - "title": "NetworkManagementClient", - "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", - "version": "2019-02-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.Network/locations/{location}/availableDelegations": { - "get": { - "operationId": "AvailableDelegations_List", - "description": "Gets all of the available subnet delegations for this subscription in this region.", - "parameters": [ - { - "name": "location", - "in": "path", - "required": true, - "type": "string", - "description": "The location of the subnet." - }, - { - "$ref": "./network.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "./network.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Request successful. Returns all of the possible delegations for a subnet in this subscription in the region.", - "schema": { - "$ref": "#/definitions/AvailableDelegationsResult" - } - } - }, - "x-ms-examples": { - "Get available delegations": { - "$ref": "./examples/AvailableDelegationsSubscriptionGet.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/locations/{location}/availableDelegations": { - "get": { - "operationId": "AvailableResourceGroupDelegations_List", - "description": "Gets all of the available subnet delegations for this resource group in this region.", - "parameters": [ - { - "name": "location", - "in": "path", - "required": true, - "type": "string", - "description": "The location of the domain name." - }, - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." - }, - { - "$ref": "./network.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "./network.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Request successful. Returns all of the possible delegations for a subnet in this subscription in the region.", - "schema": { - "$ref": "#/definitions/AvailableDelegationsResult" - } - } - }, - "x-ms-examples": { - "Get available delegations in the resource group": { - "$ref": "./examples/AvailableDelegationsResourceGroupGet.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - } - }, - "definitions": { - "AvailableDelegationsResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/AvailableDelegation" - }, - "description": "An array of available delegations." - }, - "nextLink": { - "readOnly": true, - "type": "string", - "description": "The URL to get the next set of results." - } - }, - "description": "An array of available delegations." - }, - "AvailableDelegation": { - "properties": { - "name": { - "type": "string", - "description": "The name of the AvailableDelegation resource." - }, - "id": { - "type": "string", - "description": "A unique identifier of the AvailableDelegation resource." - }, - "type": { - "type": "string", - "description": "Resource type." - }, - "serviceName": { - "type": "string", - "description": "The name of the service and resource " - }, - "actions": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Describes the actions permitted to the service upon delegation" - } - }, - "description": "The serviceName of an AvailableDelegation indicates a possible delegation for a subnet." - } - } -} +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2019-02-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.Network/locations/{location}/availableDelegations": { + "get": { + "operationId": "AvailableDelegations_List", + "description": "Gets all of the available subnet delegations for this subscription in this region.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location of the subnet." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns all of the possible delegations for a subnet in this subscription in the region.", + "schema": { + "$ref": "#/definitions/AvailableDelegationsResult" + } + } + }, + "x-ms-examples": { + "Get available delegations": { + "$ref": "./examples/AvailableDelegationsSubscriptionGet.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/locations/{location}/availableDelegations": { + "get": { + "operationId": "AvailableResourceGroupDelegations_List", + "description": "Gets all of the available subnet delegations for this resource group in this region.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location of the domain name." + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns all of the possible delegations for a subnet in this subscription in the region.", + "schema": { + "$ref": "#/definitions/AvailableDelegationsResult" + } + } + }, + "x-ms-examples": { + "Get available delegations in the resource group": { + "$ref": "./examples/AvailableDelegationsResourceGroupGet.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "AvailableDelegationsResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/AvailableDelegation" + }, + "description": "An array of available delegations." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "An array of available delegations." + }, + "AvailableDelegation": { + "properties": { + "name": { + "type": "string", + "description": "The name of the AvailableDelegation resource." + }, + "id": { + "type": "string", + "description": "A unique identifier of the AvailableDelegation resource." + }, + "type": { + "type": "string", + "description": "Resource type." + }, + "serviceName": { + "type": "string", + "description": "The name of the service and resource " + }, + "actions": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Describes the actions permitted to the service upon delegation" + } + }, + "description": "The serviceName of an AvailableDelegation indicates a possible delegation for a subnet." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-02-01/examples/ApplicationGatewayBackendHealthTest.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-02-01/examples/ApplicationGatewayBackendHealthTest.json index 8ab416d76aed..84da691ab1d7 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-02-01/examples/ApplicationGatewayBackendHealthTest.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-02-01/examples/ApplicationGatewayBackendHealthTest.json @@ -1,41 +1,41 @@ -{ - "parameters": { - "api-version": "2019-02-01", - "subscriptionId": "subid", - "resourceGroupName": "rg1", - "applicationGatewayName": "appgw", - "probeRequest": { - "protocol": "Http", - "pickHostNameFromBackendHttpSettings": true, - "path": "/", - "timeout": 30, - "backendPoolName": "MFAnalyticsPool", - "backendHttpSettingName": "MFPoolSettings" - } - }, - "responses": { - "200": { - "body": { - "backendAddressPool": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendaddressPools/MFAnalyticsPool" - }, - "backendHealthHttpSettings": { - "backendHttpSettings": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendHttpSettingsCollection/MFPoolSettings" - }, - "servers": [ - { - "address": "10.220.1.4", - "health": "Up" - }, - { - "address": "10.220.1.5", - "health": "Up" - } - ] - } - } - }, - "202": {} - } -} +{ + "parameters": { + "api-version": "2019-02-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "applicationGatewayName": "appgw", + "probeRequest": { + "protocol": "Http", + "pickHostNameFromBackendHttpSettings": true, + "path": "/", + "timeout": 30, + "backendPoolName": "MFAnalyticsPool", + "backendHttpSettingName": "MFPoolSettings" + } + }, + "responses": { + "200": { + "body": { + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendaddressPools/MFAnalyticsPool" + }, + "backendHealthHttpSettings": { + "backendHttpSettings": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendHttpSettingsCollection/MFPoolSettings" + }, + "servers": [ + { + "address": "10.220.1.4", + "health": "Up" + }, + { + "address": "10.220.1.5", + "health": "Up" + } + ] + } + } + }, + "202": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-02-01/examples/ApplicationSecurityGroupUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-02-01/examples/ApplicationSecurityGroupUpdateTags.json index 89ce80faec61..b1e56c67012c 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-02-01/examples/ApplicationSecurityGroupUpdateTags.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-02-01/examples/ApplicationSecurityGroupUpdateTags.json @@ -1,33 +1,33 @@ -{ - "parameters" : { - "api-version": "2019-02-01", - "subscriptionId" : "subid", - "resourceGroupName" : "rg1", - "applicationSecurityGroupName" : "test-asg", - "location": "westus", - "parameters": { - "tags": { - "tag1": "value1", - "tag2": "value2" - } - } - }, - "responses" : { - "200" : { - "body" : { - "name" : "test-asg", - "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationSecurityGroups/test-asg", - "type" : "Microsoft.Network/applicationSecurityGroups", - "location" : "westus", - "tags": { - "tag1": "value1", - "tag2": "value2" - }, - "properties" : { - "provisioningState": "Succeeded", - "resourceGuid": "00000000-0000-0000-0000-000000000000" - } - } - } - } -} +{ + "parameters" : { + "api-version": "2019-02-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "applicationSecurityGroupName" : "test-asg", + "location": "westus", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses" : { + "200" : { + "body" : { + "name" : "test-asg", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationSecurityGroups/test-asg", + "type" : "Microsoft.Network/applicationSecurityGroups", + "location" : "westus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties" : { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-02-01/examples/AvailableDelegationsResourceGroupGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-02-01/examples/AvailableDelegationsResourceGroupGet.json index e7b95cb8fcf9..0389845c66ad 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-02-01/examples/AvailableDelegationsResourceGroupGet.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-02-01/examples/AvailableDelegationsResourceGroupGet.json @@ -1,25 +1,25 @@ -{ - "parameters" : { - "api-version": "2019-02-01", - "location": "regionName", - "subscriptionId" : "subId", - "resourceGroupName" : "rg1" - }, - "responses" : { - "200" : { - "body" : { - "value": [ - { - "name": "Microsoft.Provider.resourceType", - "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/availableDelegations/Microsoft.Provider.resourceType", - "type": "Microsoft.Network/availableDelegations", - "serviceName": "Microsoft.Provider/resourceType", - "actions": [ - "Microsoft.Network/resource/action" - ] - } - ] - } - } - } -} +{ + "parameters" : { + "api-version": "2019-02-01", + "location": "regionName", + "subscriptionId" : "subId", + "resourceGroupName" : "rg1" + }, + "responses" : { + "200" : { + "body" : { + "value": [ + { + "name": "Microsoft.Provider.resourceType", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/availableDelegations/Microsoft.Provider.resourceType", + "type": "Microsoft.Network/availableDelegations", + "serviceName": "Microsoft.Provider/resourceType", + "actions": [ + "Microsoft.Network/resource/action" + ] + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-02-01/examples/AvailableDelegationsSubscriptionGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-02-01/examples/AvailableDelegationsSubscriptionGet.json index 4f77be82f543..345baf39590b 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-02-01/examples/AvailableDelegationsSubscriptionGet.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-02-01/examples/AvailableDelegationsSubscriptionGet.json @@ -1,24 +1,24 @@ -{ - "parameters" : { - "api-version": "2019-02-01", - "location": "regionName", - "subscriptionId" : "subId" - }, - "responses" : { - "200" : { - "body" : { - "value": [ - { - "name": "Microsoft.Provider.resourceType", - "id": "/subscriptions/subId/providers/Microsoft.Network/availableDelegations/Microsoft.Provider.resourceType", - "type": "Microsoft.Network/availableDelegations", - "serviceName": "Microsoft.Provider/resourceType", - "actions": [ - "Microsoft.Network/resource/action" - ] - } - ] - } - } - } -} +{ + "parameters" : { + "api-version": "2019-02-01", + "location": "regionName", + "subscriptionId" : "subId" + }, + "responses" : { + "200" : { + "body" : { + "value": [ + { + "name": "Microsoft.Provider.resourceType", + "id": "/subscriptions/subId/providers/Microsoft.Network/availableDelegations/Microsoft.Provider.resourceType", + "type": "Microsoft.Network/availableDelegations", + "serviceName": "Microsoft.Provider/resourceType", + "actions": [ + "Microsoft.Network/resource/action" + ] + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-02-01/examples/InterfaceEndpointCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-02-01/examples/InterfaceEndpointCreate.json index 241499107606..7c3dcb1c1977 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-02-01/examples/InterfaceEndpointCreate.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-02-01/examples/InterfaceEndpointCreate.json @@ -1,67 +1,67 @@ -{ - "parameters" : { - "api-version": "2019-02-01", - "subscriptionId" : "subId", - "resourceGroupName": "rg1", - "interfaceEndpointName": "testIe", - "parameters": { - "properties": { - "fqdn": "uniqueIdentifier.fqdn.windows.net", - "subnet": { - "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet" - }, - "endpointService": { - "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Provider/resourceType/resourceName" - } - } - } - }, - "responses" : { - "200" : { - "body" : { - "name" : "testIe", - "id" : "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/interfaceEndpoints/testIe", - "location" : "eastus", - "properties" : { - "fqdn": "uniqueIdentifier.fqdn.windows.net", - "provisioningState": "Succeded", - "owner": "User", - "endpointService": { - "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Provider/resourceType/resourceName" - }, - "subnet": { - "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet" - }, - "networkInterfaces": [ - { - "id": "/subscriptions/subId/resourceGroups/rg1/provders/Microsoft.Network/networkInterfaces/testIe.nic.abcd1234" - } - ] - } - } - }, - "201" : { - "body" : { - "name" : "testIe", - "id" : "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/interfaceEndpoints/testIe", - "location" : "eastus", - "properties" : { - "provisioningState" : "Succeeded", - "fqdn": "uniqueIdentifier.fqdn.windows.net", - "owner": "User", - "endpointService": { - "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Provider/resourceType/resourceName" - }, - "subnet": { - "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet" - }, - "networkInterfaces": [ - { - "id": "/subscriptions/subId/resourceGroups/rg1/provders/Microsoft.Network/networkInterfaces/testIe.nic.abcd1234" - } - ] - } - } - } - } -} +{ + "parameters" : { + "api-version": "2019-02-01", + "subscriptionId" : "subId", + "resourceGroupName": "rg1", + "interfaceEndpointName": "testIe", + "parameters": { + "properties": { + "fqdn": "uniqueIdentifier.fqdn.windows.net", + "subnet": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet" + }, + "endpointService": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Provider/resourceType/resourceName" + } + } + } + }, + "responses" : { + "200" : { + "body" : { + "name" : "testIe", + "id" : "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/interfaceEndpoints/testIe", + "location" : "eastus", + "properties" : { + "fqdn": "uniqueIdentifier.fqdn.windows.net", + "provisioningState": "Succeded", + "owner": "User", + "endpointService": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Provider/resourceType/resourceName" + }, + "subnet": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet" + }, + "networkInterfaces": [ + { + "id": "/subscriptions/subId/resourceGroups/rg1/provders/Microsoft.Network/networkInterfaces/testIe.nic.abcd1234" + } + ] + } + } + }, + "201" : { + "body" : { + "name" : "testIe", + "id" : "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/interfaceEndpoints/testIe", + "location" : "eastus", + "properties" : { + "provisioningState" : "Succeeded", + "fqdn": "uniqueIdentifier.fqdn.windows.net", + "owner": "User", + "endpointService": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Provider/resourceType/resourceName" + }, + "subnet": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet" + }, + "networkInterfaces": [ + { + "id": "/subscriptions/subId/resourceGroups/rg1/provders/Microsoft.Network/networkInterfaces/testIe.nic.abcd1234" + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-02-01/examples/InterfaceEndpointDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-02-01/examples/InterfaceEndpointDelete.json index 74a2a2b83cfe..adb02141ab8a 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-02-01/examples/InterfaceEndpointDelete.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-02-01/examples/InterfaceEndpointDelete.json @@ -1,13 +1,13 @@ -{ - "parameters" : { - "api-version": "2019-02-01", - "subscriptionId" : "subId", - "resourceGroupName": "rg1", - "interfaceEndpointName": "testIe" - }, - "responses" : { - "200" : { }, - "202" : { }, - "204" : { } - } -} +{ + "parameters" : { + "api-version": "2019-02-01", + "subscriptionId" : "subId", + "resourceGroupName": "rg1", + "interfaceEndpointName": "testIe" + }, + "responses" : { + "200" : { }, + "202" : { }, + "204" : { } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-02-01/examples/InterfaceEndpointGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-02-01/examples/InterfaceEndpointGet.json index 84d656889639..3070ad413d22 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-02-01/examples/InterfaceEndpointGet.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-02-01/examples/InterfaceEndpointGet.json @@ -1,34 +1,34 @@ -{ - "parameters" : { - "api-version": "2019-02-01", - "subscriptionId" : "subId", - "resourceGroupName" : "rg1", - "interfaceEndpointName" : "testIe" - }, - "responses" : { - "200" : { - "body" : { - "name" : "testIe", - "id" : "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/interfaceEndpoints/testIe", - "type" : "Microsoft.Network/interfaceEndpoints", - "location" : "eastus", - "properties" : { - "provisioningState" : "Succeeded", - "fqdn": "uniqueIdentifier.fqdn.windows.net", - "owner": "User", - "endpointService": { - "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Provider/resourceType/resourceName" - }, - "subnet": { - "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet" - }, - "networkInterfaces": [ - { - "id": "/subscriptions/subId/resourceGroups/rg1/provders/Microsoft.Network/networkInterfaces/testIe.nic.abcd1234" - } - ] - } - } - } - } -} +{ + "parameters" : { + "api-version": "2019-02-01", + "subscriptionId" : "subId", + "resourceGroupName" : "rg1", + "interfaceEndpointName" : "testIe" + }, + "responses" : { + "200" : { + "body" : { + "name" : "testIe", + "id" : "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/interfaceEndpoints/testIe", + "type" : "Microsoft.Network/interfaceEndpoints", + "location" : "eastus", + "properties" : { + "provisioningState" : "Succeeded", + "fqdn": "uniqueIdentifier.fqdn.windows.net", + "owner": "User", + "endpointService": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Provider/resourceType/resourceName" + }, + "subnet": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet" + }, + "networkInterfaces": [ + { + "id": "/subscriptions/subId/resourceGroups/rg1/provders/Microsoft.Network/networkInterfaces/testIe.nic.abcd1234" + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-02-01/examples/InterfaceEndpointList.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-02-01/examples/InterfaceEndpointList.json index 564d80efe0d1..639c61da3f7c 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-02-01/examples/InterfaceEndpointList.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-02-01/examples/InterfaceEndpointList.json @@ -1,59 +1,59 @@ -{ - "parameters" : { - "api-version": "2019-02-01", - "subscriptionId" : "subId", - "resourceGroupName" : "rg1" - }, - "responses" : { - "200" : { - "body" : { - "value": [ - { - "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/interfaceEndpoints/ie1", - "name": "ie1", - "type": "Microsoft.Network/interfaceEndpoints", - "location": "eastus", - "properties" : { - "provisioningState" : "Succeeded", - "fqdn": "uniqueIdentifier.fqdn.windows.net", - "owner": "User", - "endpointService": { - "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Provider/resourceType/resourceName" - }, - "subnet": { - "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet" - }, - "networkInterfaces": [ - { - "id": "/subscriptions/subId/resourceGroups/rg1/provders/Microsoft.Network/networkInterfaces/ie1.nic.abcd1234" - } - ] - } - }, - { - "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/interfaceEndpoints/ie2", - "name": "ie2", - "type": "Microsoft.Network/interfaceEndpoints", - "location": "eastus", - "properties" : { - "provisioningState" : "Succeeded", - "fqdn": "alsoUnique.fqdn.windows.net", - "owner": "User", - "endpointService": { - "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Provider/resourceType/otherResourceName" - }, - "subnet": { - "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet" - }, - "networkInterfaces": [ - { - "id": "/subscriptions/subId/resourceGroups/rg1/provders/Microsoft.Network/networkInterfaces/ie2.nic.zyxw9876" - } - ] - } - } - ] - } - } - } -} +{ + "parameters" : { + "api-version": "2019-02-01", + "subscriptionId" : "subId", + "resourceGroupName" : "rg1" + }, + "responses" : { + "200" : { + "body" : { + "value": [ + { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/interfaceEndpoints/ie1", + "name": "ie1", + "type": "Microsoft.Network/interfaceEndpoints", + "location": "eastus", + "properties" : { + "provisioningState" : "Succeeded", + "fqdn": "uniqueIdentifier.fqdn.windows.net", + "owner": "User", + "endpointService": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Provider/resourceType/resourceName" + }, + "subnet": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet" + }, + "networkInterfaces": [ + { + "id": "/subscriptions/subId/resourceGroups/rg1/provders/Microsoft.Network/networkInterfaces/ie1.nic.abcd1234" + } + ] + } + }, + { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/interfaceEndpoints/ie2", + "name": "ie2", + "type": "Microsoft.Network/interfaceEndpoints", + "location": "eastus", + "properties" : { + "provisioningState" : "Succeeded", + "fqdn": "alsoUnique.fqdn.windows.net", + "owner": "User", + "endpointService": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Provider/resourceType/otherResourceName" + }, + "subnet": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet" + }, + "networkInterfaces": [ + { + "id": "/subscriptions/subId/resourceGroups/rg1/provders/Microsoft.Network/networkInterfaces/ie2.nic.zyxw9876" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-02-01/examples/InterfaceEndpointListAll.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-02-01/examples/InterfaceEndpointListAll.json index 9dcfdaef16d7..ebdb0d36a0b0 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-02-01/examples/InterfaceEndpointListAll.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-02-01/examples/InterfaceEndpointListAll.json @@ -1,80 +1,80 @@ -{ - "parameters" : { - "api-version": "2019-02-01", - "subscriptionId" : "subId" - }, - "responses" : { - "200" : { - "body" : { - "value": [ - { - "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/interfaceEndpoints/ie1", - "name": "ie1", - "type": "Microsoft.Network/interfaceEndpoints", - "location": "eastus", - "properties" : { - "provisioningState" : "Succeeded", - "fqdn": "uniqueIdentifier.fqdn.windows.net", - "owner": "User", - "endpointService": { - "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Provider/resourceType/resourceName" - }, - "subnet": { - "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet" - }, - "networkInterfaces": [ - { - "id": "/subscriptions/subId/resourceGroups/rg1/provders/Microsoft.Network/networkInterfaces/ie1.nic.abcd1234" - } - ] - } - }, - { - "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/interfaceEndpoints/ie2", - "name": "ie2", - "type": "Microsoft.Network/interfaceEndpoints", - "location": "eastus", - "properties" : { - "provisioningState" : "Succeeded", - "fqdn": "alsoUnique.fqdn.windows.net", - "owner": "User", - "endpointService": { - "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Provider/resourceType/otherResourceName" - }, - "subnet": { - "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet" - }, - "networkInterfaces": [ - { - "id": "/subscriptions/subId/resourceGroups/rg1/provders/Microsoft.Network/networkInterfaces/ie2.nic.zyxw9876" - } - ] - } - }, - { - "id": "/subscriptions/subId/resourceGroups/rg2/providers/Microsoft.Network/interfaceEndpoints/ie1", - "name": "ie1", - "type": "Microsoft.Network/interfaceEndpoints", - "location": "eastus", - "properties" : { - "provisioningState" : "Succeeded", - "fqdn": "stillVeryUnique.fqdn.windows.net", - "owner": "User", - "endpointService": { - "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Provider/resourceType/resourceName" - }, - "subnet": { - "id": "/subscriptions/subId/resourceGroups/rg2/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet" - }, - "networkInterfaces": [ - { - "id": "/subscriptions/subId/resourceGroups/rg2/provders/Microsoft.Network/networkInterfaces/ie1.nic.efgh5463" - } - ] - } - } - ] - } - } - } -} +{ + "parameters" : { + "api-version": "2019-02-01", + "subscriptionId" : "subId" + }, + "responses" : { + "200" : { + "body" : { + "value": [ + { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/interfaceEndpoints/ie1", + "name": "ie1", + "type": "Microsoft.Network/interfaceEndpoints", + "location": "eastus", + "properties" : { + "provisioningState" : "Succeeded", + "fqdn": "uniqueIdentifier.fqdn.windows.net", + "owner": "User", + "endpointService": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Provider/resourceType/resourceName" + }, + "subnet": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet" + }, + "networkInterfaces": [ + { + "id": "/subscriptions/subId/resourceGroups/rg1/provders/Microsoft.Network/networkInterfaces/ie1.nic.abcd1234" + } + ] + } + }, + { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/interfaceEndpoints/ie2", + "name": "ie2", + "type": "Microsoft.Network/interfaceEndpoints", + "location": "eastus", + "properties" : { + "provisioningState" : "Succeeded", + "fqdn": "alsoUnique.fqdn.windows.net", + "owner": "User", + "endpointService": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Provider/resourceType/otherResourceName" + }, + "subnet": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet" + }, + "networkInterfaces": [ + { + "id": "/subscriptions/subId/resourceGroups/rg1/provders/Microsoft.Network/networkInterfaces/ie2.nic.zyxw9876" + } + ] + } + }, + { + "id": "/subscriptions/subId/resourceGroups/rg2/providers/Microsoft.Network/interfaceEndpoints/ie1", + "name": "ie1", + "type": "Microsoft.Network/interfaceEndpoints", + "location": "eastus", + "properties" : { + "provisioningState" : "Succeeded", + "fqdn": "stillVeryUnique.fqdn.windows.net", + "owner": "User", + "endpointService": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Provider/resourceType/resourceName" + }, + "subnet": { + "id": "/subscriptions/subId/resourceGroups/rg2/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet" + }, + "networkInterfaces": [ + { + "id": "/subscriptions/subId/resourceGroups/rg2/provders/Microsoft.Network/networkInterfaces/ie1.nic.efgh5463" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-02-01/examples/SubnetCreateWithDelegation.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-02-01/examples/SubnetCreateWithDelegation.json index ae29da78a4c2..649ce8ec2870 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-02-01/examples/SubnetCreateWithDelegation.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-02-01/examples/SubnetCreateWithDelegation.json @@ -1,60 +1,60 @@ -{ - "parameters": { - "subnetName": "subnet1", - "virtualNetworkName": "vnetname", - "resourceGroupName": "subnet-test", - "api-version": "2019-02-01", - "subscriptionId": "subId", - "subnetParameters": { - "properties": { - "addressPrefix": "10.0.0.0/16" - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/subId/resourceGroups/subnet-test/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/subnet1", - "name": "subnet1", - "properties": { - "addressPrefix": "10.0.0.0/16", - "provisioningState": "Succeeded", - "delegations": [ - { - "name": "myDelegation", - "id": "/subscriptions/subId/resourceGroups/subnet-test/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/subnet1/delegations/myDelegation", - "properties": { - "provisioningState": "Succeeded", - "serviceName": "Microsoft.Provider/resourceType", - "actions": [] - } - } - ], - "purpose": "" - } - } - }, - "201": { - "body": { - "id": "/subscriptions/subId/resourceGroups/subnet-test/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/subnet1", - "name": "subnet1", - "properties": { - "addressPrefix": "10.0.0.0/16", - "provisioningState": "Succeeded", - "delegations": [ - { - "name": "myDelegation", - "id": "/subscriptions/subId/resourceGroups/subnet-test/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/subnet1/delegations/myDelegation", - "properties": { - "provisioningState": "Succeeded", - "serviceName": "Microsoft.Provider/resourceType", - "actions": [] - } - } - ], - "purpose": "" - } - } - } - } -} +{ + "parameters": { + "subnetName": "subnet1", + "virtualNetworkName": "vnetname", + "resourceGroupName": "subnet-test", + "api-version": "2019-02-01", + "subscriptionId": "subId", + "subnetParameters": { + "properties": { + "addressPrefix": "10.0.0.0/16" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subId/resourceGroups/subnet-test/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/subnet1", + "name": "subnet1", + "properties": { + "addressPrefix": "10.0.0.0/16", + "provisioningState": "Succeeded", + "delegations": [ + { + "name": "myDelegation", + "id": "/subscriptions/subId/resourceGroups/subnet-test/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/subnet1/delegations/myDelegation", + "properties": { + "provisioningState": "Succeeded", + "serviceName": "Microsoft.Provider/resourceType", + "actions": [] + } + } + ], + "purpose": "" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subId/resourceGroups/subnet-test/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/subnet1", + "name": "subnet1", + "properties": { + "addressPrefix": "10.0.0.0/16", + "provisioningState": "Succeeded", + "delegations": [ + { + "name": "myDelegation", + "id": "/subscriptions/subId/resourceGroups/subnet-test/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/subnet1/delegations/myDelegation", + "properties": { + "provisioningState": "Succeeded", + "serviceName": "Microsoft.Provider/resourceType", + "actions": [] + } + } + ], + "purpose": "" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-02-01/examples/SubnetGetWithDelegation.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-02-01/examples/SubnetGetWithDelegation.json index 77965d139b3d..e9d244333b53 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-02-01/examples/SubnetGetWithDelegation.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-02-01/examples/SubnetGetWithDelegation.json @@ -1,33 +1,33 @@ -{ - "parameters": { - "subnetName": "subnet1", - "virtualNetworkName": "vnetname", - "resourceGroupName": "subnet-test", - "api-version": "2019-02-01", - "subscriptionId": "subId" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/subId/resourceGroups/subnet-test/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/subnet1", - "name": "subnet1", - "properties": { - "addressPrefix": "10.0.0.0/16", - "provisioningState": "Succeeded", - "delegations": [ - { - "name": "myDelegation", - "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1/delegations/myDelegation", - "properties": { - "provisioningState": "Succeeded", - "serviceName": "Microsoft.Provider/resourceType", - "actions": [] - } - } - ], - "purpose": "" - } - } - } - } -} +{ + "parameters": { + "subnetName": "subnet1", + "virtualNetworkName": "vnetname", + "resourceGroupName": "subnet-test", + "api-version": "2019-02-01", + "subscriptionId": "subId" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subId/resourceGroups/subnet-test/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/subnet1", + "name": "subnet1", + "properties": { + "addressPrefix": "10.0.0.0/16", + "provisioningState": "Succeeded", + "delegations": [ + { + "name": "myDelegation", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1/delegations/myDelegation", + "properties": { + "provisioningState": "Succeeded", + "serviceName": "Microsoft.Provider/resourceType", + "actions": [] + } + } + ], + "purpose": "" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-02-01/examples/VirtualNetworkCreateSubnetWithDelegation.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-02-01/examples/VirtualNetworkCreateSubnetWithDelegation.json index ab650d845ee1..368184418a7f 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-02-01/examples/VirtualNetworkCreateSubnetWithDelegation.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-02-01/examples/VirtualNetworkCreateSubnetWithDelegation.json @@ -1,114 +1,114 @@ -{ - "parameters" : { - "api-version": "2019-02-01", - "subscriptionId" : "subId", - "resourceGroupName" : "rg1", - "virtualNetworkName" : "test-vnet", - "parameters": { - "properties": { - "addressSpace": { - "addressPrefixes": [ - "10.0.0.0/16" - ] - }, - "subnets": [ - { - "name": "test-1", - "properties": { - "addressPrefix": "10.0.0.0/24", - "delegations": [ - { - "name": "myDelegation", - "properties": { - "serviceName": "Microsoft.Provider/resourceType" - } - } - ] - } - } - ] - }, - "location": "eastus" - } - }, - "responses" : { - "200" : { - "body" : { - "name" : "test-vnet", - "id" : "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet", - "type" : "Microsoft.Network/virtualNetworks", - "location" : "eastus", - "properties" : { - "provisioningState" : "Succeeded", - "addressSpace" : { - "addressPrefixes" : [ - "10.0.0.0/16" - ] - }, - "subnets": [ - { - "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-1", - "name": "test-1", - "properties": { - "addressPrefix": "10.0.0.0/24", - "provisioningState": "Succeeded", - "delegations": [ - { - "name": "myDelegation", - "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-1/delegations/myDelegation", - "properties": { - "provisioningState": "Succeeded", - "serviceName": "Microsoft.Provider/resourceType", - "actions": [] - } - } - ], - "purpose": "" - } - } - ], - "virtualNetworkPeerings" : [] - } - } - }, - "201" : { - "body" : { - "name" : "test-vnet", - "id" : "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet", - "type" : "Microsoft.Network/virtualNetworks", - "location" : "eastus", - "properties" : { - "provisioningState" : "Succeeded", - "addressSpace" : { - "addressPrefixes" : [ - "10.0.0.0/16" - ] - }, - "subnets": [ - { - "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-1", - "name": "test-1", - "properties": { - "addressPrefix": "10.0.0.0/24", - "provisioningState": "Succeeded", - "delegations": [ - { - "name": "myDelegation", - "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-1/delegations/myDelegation", - "properties": { - "provisioningState": "Succeeded", - "serviceName": "Microsoft.Provider/resourceType", - "actions": [] - } - } - ], - "purpose": "" - } - } - ], - "virtualNetworkPeerings" : [] - } - } - } - } -} +{ + "parameters" : { + "api-version": "2019-02-01", + "subscriptionId" : "subId", + "resourceGroupName" : "rg1", + "virtualNetworkName" : "test-vnet", + "parameters": { + "properties": { + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "subnets": [ + { + "name": "test-1", + "properties": { + "addressPrefix": "10.0.0.0/24", + "delegations": [ + { + "name": "myDelegation", + "properties": { + "serviceName": "Microsoft.Provider/resourceType" + } + } + ] + } + } + ] + }, + "location": "eastus" + } + }, + "responses" : { + "200" : { + "body" : { + "name" : "test-vnet", + "id" : "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet", + "type" : "Microsoft.Network/virtualNetworks", + "location" : "eastus", + "properties" : { + "provisioningState" : "Succeeded", + "addressSpace" : { + "addressPrefixes" : [ + "10.0.0.0/16" + ] + }, + "subnets": [ + { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-1", + "name": "test-1", + "properties": { + "addressPrefix": "10.0.0.0/24", + "provisioningState": "Succeeded", + "delegations": [ + { + "name": "myDelegation", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-1/delegations/myDelegation", + "properties": { + "provisioningState": "Succeeded", + "serviceName": "Microsoft.Provider/resourceType", + "actions": [] + } + } + ], + "purpose": "" + } + } + ], + "virtualNetworkPeerings" : [] + } + } + }, + "201" : { + "body" : { + "name" : "test-vnet", + "id" : "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet", + "type" : "Microsoft.Network/virtualNetworks", + "location" : "eastus", + "properties" : { + "provisioningState" : "Succeeded", + "addressSpace" : { + "addressPrefixes" : [ + "10.0.0.0/16" + ] + }, + "subnets": [ + { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-1", + "name": "test-1", + "properties": { + "addressPrefix": "10.0.0.0/24", + "provisioningState": "Succeeded", + "delegations": [ + { + "name": "myDelegation", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-1/delegations/myDelegation", + "properties": { + "provisioningState": "Succeeded", + "serviceName": "Microsoft.Provider/resourceType", + "actions": [] + } + } + ], + "purpose": "" + } + } + ], + "virtualNetworkPeerings" : [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-02-01/examples/VirtualNetworkGetWithSubnetDelegation.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-02-01/examples/VirtualNetworkGetWithSubnetDelegation.json index c5a64c0a1527..b97c14c221ae 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-02-01/examples/VirtualNetworkGetWithSubnetDelegation.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-02-01/examples/VirtualNetworkGetWithSubnetDelegation.json @@ -1,48 +1,48 @@ -{ - "parameters": { - "api-version": "2019-02-01", - "subscriptionId": "subId", - "resourceGroupName": "rg1", - "virtualNetworkName": "test-vnet" - }, - "responses": { - "200": { - "body": { - "name": "test-vnet", - "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet", - "type": "Microsoft.Network/virtualNetworks", - "location": "westus", - "properties": { - "provisioningState": "Succeeded", - "addressSpace": { - "addressPrefixes": [ - "10.0.0.0/16" - ] - }, - "subnets": [{ - "name": "subnet1", - "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1", - "properties": { - "provisioningState": "Succeeded", - "addressPrefix": "10.0.1.0/24", - "ipConfigurations": [{ - "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe" - }], - "delegations": [{ - "name": "myDelegation", - "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1/delegations/myDelegation", - "properties": { - "provisioningState": "Succeeded", - "serviceName": "Microsoft.Provider/resourceType", - "actions": [] - } - }], - "purpose": "" - } - }], - "virtualNetworkPeerings": [] - } - } - } - } +{ + "parameters": { + "api-version": "2019-02-01", + "subscriptionId": "subId", + "resourceGroupName": "rg1", + "virtualNetworkName": "test-vnet" + }, + "responses": { + "200": { + "body": { + "name": "test-vnet", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet", + "type": "Microsoft.Network/virtualNetworks", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "subnets": [{ + "name": "subnet1", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1", + "properties": { + "provisioningState": "Succeeded", + "addressPrefix": "10.0.1.0/24", + "ipConfigurations": [{ + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe" + }], + "delegations": [{ + "name": "myDelegation", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1/delegations/myDelegation", + "properties": { + "provisioningState": "Succeeded", + "serviceName": "Microsoft.Provider/resourceType", + "actions": [] + } + }], + "purpose": "" + } + }], + "virtualNetworkPeerings": [] + } + } + } + } } \ No newline at end of file diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-02-01/interfaceEndpoint.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-02-01/interfaceEndpoint.json index 46c6423076ed..c2ae4918a66a 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-02-01/interfaceEndpoint.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-02-01/interfaceEndpoint.json @@ -1,344 +1,344 @@ -{ - "swagger": "2.0", - "info": { - "title": "NetworkManagementClient", - "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", - "version": "2019-02-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}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/interfaceEndpoints/{interfaceEndpointName}": { - "delete": { - "tags": [ - "InterfaceEndpoints" - ], - "operationId": "InterfaceEndpoints_Delete", - "description": "Deletes the specified interface endpoint.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." - }, - { - "name": "interfaceEndpointName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the interface endpoint." - }, - { - "$ref": "./network.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "./network.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "202": { - "description": "Accepted and the operation will complete asynchronously." - }, - "204": { - "description": "Delete successful." - }, - "200": { - "description": "Delete successful." - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" - }, - "x-ms-examples": { - "Delete interface endpoint": { "$ref": "./examples/InterfaceEndpointDelete.json" } - } - }, - "get": { - "tags": [ - "InterfaceEndpoints" - ], - "operationId": "InterfaceEndpoints_Get", - "description": "Gets the specified interface endpoint by resource group.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." - }, - { - "name": "interfaceEndpointName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the interface endpoint." - }, - { - "$ref": "./network.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "./network.json#/parameters/SubscriptionIdParameter" - }, - { - "name": "$expand", - "in": "query", - "required": false, - "type": "string", - "description": "Expands referenced resources." - } - ], - "responses": { - "200": { - "description": "Request successful. The operation returns the resulting InterfaceEndpoint resource.", - "schema": { - "$ref": "#/definitions/InterfaceEndpoint" - } - } - }, - "x-ms-examples": { - "Get interface endpoint": { "$ref": "./examples/InterfaceEndpointGet.json" } - } - }, - "put": { - "tags": [ - "InterfaceEndpoints" - ], - "operationId": "InterfaceEndpoints_CreateOrUpdate", - "description": "Creates or updates an interface endpoint in the specified resource group.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." - }, - { - "name": "interfaceEndpointName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the interface endpoint." - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/InterfaceEndpoint" - }, - "description": "Parameters supplied to the create or update interface endpoint operation" - }, - { - "$ref": "./network.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "./network.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Update successful. The operation returns the resulting InterfaceEndpoint resource.", - "schema": { - "$ref": "#/definitions/InterfaceEndpoint" - } - }, - "201": { - "description": "Create successful. The operation returns the resulting InterfaceEndpoint resource.", - "schema": { - "$ref": "#/definitions/InterfaceEndpoint" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "azure-async-operation" - }, - "x-ms-examples": { - "Create interface endpoint": { "$ref": "./examples/InterfaceEndpointCreate.json" } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/interfaceEndpoints": { - "get": { - "tags": [ - "InterfaceEndpoints" - ], - "operationId": "InterfaceEndpoints_List", - "description": "Gets all interface endpoints in a resource group.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." - }, - { - "$ref": "./network.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "./network.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Request successful. The operation returns a list of InterfaceEndpoint resources.", - "schema": { - "$ref": "#/definitions/InterfaceEndpointListResult" - } - } - }, - "x-ms-examples": { - "List interface endpoints in resource group": { "$ref": "./examples/InterfaceEndpointList.json" } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Network/interfaceEndpoints": { - "get": { - "tags": [ - "InterfaceEndpoints" - ], - "operationId": "InterfaceEndpoints_ListBySubscription", - "description": "Gets all interface endpoints in a subscription.", - "parameters": [ - { - "$ref": "./network.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "./network.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Request successful. The operation returns a list of InterfaceEndpoint resources.", - "schema": { - "$ref": "#/definitions/InterfaceEndpointListResult" - } - } - }, - "x-ms-examples": { - "List all interface endpoints": { "$ref": "./examples/InterfaceEndpointListAll.json" } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - } - }, - "definitions": { - "InterfaceEndpoint": { - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/InterfaceEndpointProperties", - "description": "Properties of the interface endpoint." - }, - "etag": { - "type": "string", - "description": "Gets a unique read-only string that changes whenever the resource is updated." - } - }, - "allOf": [ - { - "$ref": "./network.json#/definitions/Resource" - } - ], - "description": "Interface endpoint resource." - }, - "InterfaceEndpointProperties": { - "properties": { - "fqdn": { - "type": "string", - "description": "A first-party service's FQDN that is mapped to the private IP allocated via this interface endpoint." - }, - "endpointService": { - "$ref": "#/definitions/EndpointService", - "description": "A reference to the service being brought into the virtual network." - }, - "subnet": { - "$ref": "./virtualNetwork.json#/definitions/Subnet", - "description": "The ID of the subnet from which the private IP will be allocated." - }, - "networkInterfaces": { - "type": "array", - "readOnly": true, - "items": { - "$ref": "./networkInterface.json#/definitions/NetworkInterface" - }, - "description": "Gets an array of references to the network interfaces created for this interface endpoint." - }, - "owner": { - "type": "string", - "readOnly": true, - "description": "A read-only property that identifies who created this interface endpoint." - }, - "provisioningState": { - "readOnly": true, - "type": "string", - "description": "The provisioning state of the interface endpoint. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Properties of the interface endpoint." - }, - "EndpointService": { - "properties": { - "id": { - "type": "string", - "description": "A unique identifier of the service being referenced by the interface endpoint." - } - }, - "description": "Identifies the service being brought into the virtual network." - }, - "InterfaceEndpointListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/InterfaceEndpoint" - }, - "description": "Gets a list of InterfaceEndpoint resources in a resource group." - }, - "nextLink": { - "type": "string", - "description": "The URL to get the next set of results.", - "readOnly": true - } - }, - "description": "Response for the ListInterfaceEndpoints API service call." - } - } -} +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2019-02-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}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/interfaceEndpoints/{interfaceEndpointName}": { + "delete": { + "tags": [ + "InterfaceEndpoints" + ], + "operationId": "InterfaceEndpoints_Delete", + "description": "Deletes the specified interface endpoint.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "interfaceEndpointName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the interface endpoint." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "204": { + "description": "Delete successful." + }, + "200": { + "description": "Delete successful." + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Delete interface endpoint": { "$ref": "./examples/InterfaceEndpointDelete.json" } + } + }, + "get": { + "tags": [ + "InterfaceEndpoints" + ], + "operationId": "InterfaceEndpoints_Get", + "description": "Gets the specified interface endpoint by resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "interfaceEndpointName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the interface endpoint." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "Expands referenced resources." + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting InterfaceEndpoint resource.", + "schema": { + "$ref": "#/definitions/InterfaceEndpoint" + } + } + }, + "x-ms-examples": { + "Get interface endpoint": { "$ref": "./examples/InterfaceEndpointGet.json" } + } + }, + "put": { + "tags": [ + "InterfaceEndpoints" + ], + "operationId": "InterfaceEndpoints_CreateOrUpdate", + "description": "Creates or updates an interface endpoint in the specified resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "interfaceEndpointName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the interface endpoint." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/InterfaceEndpoint" + }, + "description": "Parameters supplied to the create or update interface endpoint operation" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting InterfaceEndpoint resource.", + "schema": { + "$ref": "#/definitions/InterfaceEndpoint" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting InterfaceEndpoint resource.", + "schema": { + "$ref": "#/definitions/InterfaceEndpoint" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Create interface endpoint": { "$ref": "./examples/InterfaceEndpointCreate.json" } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/interfaceEndpoints": { + "get": { + "tags": [ + "InterfaceEndpoints" + ], + "operationId": "InterfaceEndpoints_List", + "description": "Gets all interface endpoints in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of InterfaceEndpoint resources.", + "schema": { + "$ref": "#/definitions/InterfaceEndpointListResult" + } + } + }, + "x-ms-examples": { + "List interface endpoints in resource group": { "$ref": "./examples/InterfaceEndpointList.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/interfaceEndpoints": { + "get": { + "tags": [ + "InterfaceEndpoints" + ], + "operationId": "InterfaceEndpoints_ListBySubscription", + "description": "Gets all interface endpoints in a subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of InterfaceEndpoint resources.", + "schema": { + "$ref": "#/definitions/InterfaceEndpointListResult" + } + } + }, + "x-ms-examples": { + "List all interface endpoints": { "$ref": "./examples/InterfaceEndpointListAll.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "InterfaceEndpoint": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/InterfaceEndpointProperties", + "description": "Properties of the interface endpoint." + }, + "etag": { + "type": "string", + "description": "Gets a unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "Interface endpoint resource." + }, + "InterfaceEndpointProperties": { + "properties": { + "fqdn": { + "type": "string", + "description": "A first-party service's FQDN that is mapped to the private IP allocated via this interface endpoint." + }, + "endpointService": { + "$ref": "#/definitions/EndpointService", + "description": "A reference to the service being brought into the virtual network." + }, + "subnet": { + "$ref": "./virtualNetwork.json#/definitions/Subnet", + "description": "The ID of the subnet from which the private IP will be allocated." + }, + "networkInterfaces": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "./networkInterface.json#/definitions/NetworkInterface" + }, + "description": "Gets an array of references to the network interfaces created for this interface endpoint." + }, + "owner": { + "type": "string", + "readOnly": true, + "description": "A read-only property that identifies who created this interface endpoint." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state of the interface endpoint. Possible values are: 'Updating', 'Deleting', and 'Failed'." + } + }, + "description": "Properties of the interface endpoint." + }, + "EndpointService": { + "properties": { + "id": { + "type": "string", + "description": "A unique identifier of the service being referenced by the interface endpoint." + } + }, + "description": "Identifies the service being brought into the virtual network." + }, + "InterfaceEndpointListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/InterfaceEndpoint" + }, + "description": "Gets a list of InterfaceEndpoint resources in a resource group." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results.", + "readOnly": true + } + }, + "description": "Response for the ListInterfaceEndpoints API service call." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-02-01/usage.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-02-01/usage.json index 7b6a5c70dd13..2f6ff0c5db5a 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-02-01/usage.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-02-01/usage.json @@ -48,7 +48,7 @@ "required": true, "type": "string", "description": "The location where resource usage is queried.", - "pattern": "^[-\\w\\._ ]+$" + "pattern": "^[-\\w\\._ ]+$" }, { "$ref": "./network.json#/parameters/ApiVersionParameter" @@ -66,8 +66,8 @@ } }, "x-ms-examples": { - "List usages": { "$ref": "./examples/UsageList.json" }, - "List usages spaced location": { "$ref": "./examples/UsageListSpacedLocation.json" } + "List usages": { "$ref": "./examples/UsageList.json" }, + "List usages spaced location": { "$ref": "./examples/UsageListSpacedLocation.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/applicationGateway.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/applicationGateway.json index 04134e713fc0..fddfa9503836 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/applicationGateway.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/applicationGateway.json @@ -816,11 +816,11 @@ "properties": { "backendAddressPool": { "$ref": "#/definitions/ApplicationGatewayBackendAddressPool", - "description": "Reference of an ApplicationGatewayBackendAddressPool resource." + "description": "Reference of an ApplicationGatewayBackendAddressPool resource." }, "backendHealthHttpSettings": { "$ref": "#/definitions/ApplicationGatewayBackendHealthHttpSettings", - "description": "Application gateway BackendHealthHttp settings." + "description": "Application gateway BackendHealthHttp settings." } }, "description": "Result of on demand test probe" @@ -2310,21 +2310,21 @@ ], "description": "Allows to disable rules within a rule group or an entire rule group." }, - "ApplicationGatewayAvailableServerVariablesResult": { + "ApplicationGatewayAvailableServerVariablesResult": { "type": "array", "items": { "type": "string" }, "description": "Response for ApplicationGatewayAvailableServerVariables API service call." }, - "ApplicationGatewayAvailableRequestHeadersResult": { + "ApplicationGatewayAvailableRequestHeadersResult": { "type": "array", "items": { "type": "string" }, "description": "Response for ApplicationGatewayAvailableRequestHeaders API service call." }, - "ApplicationGatewayAvailableResponseHeadersResult": { + "ApplicationGatewayAvailableResponseHeadersResult": { "type": "array", "items": { "type": "string" @@ -2546,7 +2546,7 @@ }, "description": "Properties of ApplicationGatewaySslPredefinedPolicy" }, - "ApplicationGatewayCustomError": { + "ApplicationGatewayCustomError": { "properties": { "statusCode": { "type": "string", diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/availableDelegations.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/availableDelegations.json index f133d2d09447..8ae8ee65ac1d 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/availableDelegations.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/availableDelegations.json @@ -1,166 +1,166 @@ -{ - "swagger": "2.0", - "info": { - "title": "NetworkManagementClient", - "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", - "version": "2019-04-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.Network/locations/{location}/availableDelegations": { - "get": { - "operationId": "AvailableDelegations_List", - "description": "Gets all of the available subnet delegations for this subscription in this region.", - "parameters": [ - { - "name": "location", - "in": "path", - "required": true, - "type": "string", - "description": "The location of the subnet." - }, - { - "$ref": "./network.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "./network.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Request successful. Returns all of the possible delegations for a subnet in this subscription in the region.", - "schema": { - "$ref": "#/definitions/AvailableDelegationsResult" - } - } - }, - "x-ms-examples": { - "Get available delegations": { - "$ref": "./examples/AvailableDelegationsSubscriptionGet.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/locations/{location}/availableDelegations": { - "get": { - "operationId": "AvailableResourceGroupDelegations_List", - "description": "Gets all of the available subnet delegations for this resource group in this region.", - "parameters": [ - { - "name": "location", - "in": "path", - "required": true, - "type": "string", - "description": "The location of the domain name." - }, - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." - }, - { - "$ref": "./network.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "./network.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Request successful. Returns all of the possible delegations for a subnet in this subscription in the region.", - "schema": { - "$ref": "#/definitions/AvailableDelegationsResult" - } - } - }, - "x-ms-examples": { - "Get available delegations in the resource group": { - "$ref": "./examples/AvailableDelegationsResourceGroupGet.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - } - }, - "definitions": { - "AvailableDelegationsResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/AvailableDelegation" - }, - "description": "An array of available delegations." - }, - "nextLink": { - "readOnly": true, - "type": "string", - "description": "The URL to get the next set of results." - } - }, - "description": "An array of available delegations." - }, - "AvailableDelegation": { - "properties": { - "name": { - "type": "string", - "description": "The name of the AvailableDelegation resource." - }, - "id": { - "type": "string", - "description": "A unique identifier of the AvailableDelegation resource." - }, - "type": { - "type": "string", - "description": "Resource type." - }, - "serviceName": { - "type": "string", - "description": "The name of the service and resource " - }, - "actions": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Describes the actions permitted to the service upon delegation" - } - }, - "description": "The serviceName of an AvailableDelegation indicates a possible delegation for a subnet." - } - } -} +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2019-04-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.Network/locations/{location}/availableDelegations": { + "get": { + "operationId": "AvailableDelegations_List", + "description": "Gets all of the available subnet delegations for this subscription in this region.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location of the subnet." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns all of the possible delegations for a subnet in this subscription in the region.", + "schema": { + "$ref": "#/definitions/AvailableDelegationsResult" + } + } + }, + "x-ms-examples": { + "Get available delegations": { + "$ref": "./examples/AvailableDelegationsSubscriptionGet.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/locations/{location}/availableDelegations": { + "get": { + "operationId": "AvailableResourceGroupDelegations_List", + "description": "Gets all of the available subnet delegations for this resource group in this region.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location of the domain name." + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns all of the possible delegations for a subnet in this subscription in the region.", + "schema": { + "$ref": "#/definitions/AvailableDelegationsResult" + } + } + }, + "x-ms-examples": { + "Get available delegations in the resource group": { + "$ref": "./examples/AvailableDelegationsResourceGroupGet.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "AvailableDelegationsResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/AvailableDelegation" + }, + "description": "An array of available delegations." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "An array of available delegations." + }, + "AvailableDelegation": { + "properties": { + "name": { + "type": "string", + "description": "The name of the AvailableDelegation resource." + }, + "id": { + "type": "string", + "description": "A unique identifier of the AvailableDelegation resource." + }, + "type": { + "type": "string", + "description": "Resource type." + }, + "serviceName": { + "type": "string", + "description": "The name of the service and resource " + }, + "actions": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Describes the actions permitted to the service upon delegation" + } + }, + "description": "The serviceName of an AvailableDelegation indicates a possible delegation for a subnet." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/azureFirewallFqdnTag.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/azureFirewallFqdnTag.json index 6b9fca3e7efa..ff09d8fcb517 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/azureFirewallFqdnTag.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/azureFirewallFqdnTag.json @@ -41,7 +41,7 @@ ], "operationId": "AzureFirewallFqdnTags_ListAll", "description":"Gets all the Azure Firewall FQDN Tags in a subscription.", - "parameters":[ + "parameters":[ { "$ref":"#/parameters/ApiVersionParameter" }, @@ -49,20 +49,20 @@ "$ref":"#/parameters/SubscriptionIdParameter" } ], - "responses":{ - "200":{ + "responses":{ + "200":{ "description":"Success. The operation returns a list of Azure Firewall FQDN Tag resources.", - "schema":{ + "schema":{ "$ref":"#/definitions/AzureFirewallFqdnTagListResult" } } }, - "x-ms-examples":{ - "List all Azure Firewall FQDN Tags for a given subscription":{ + "x-ms-examples":{ + "List all Azure Firewall FQDN Tags for a given subscription":{ "$ref":"./examples/AzureFirewallFqdnTagsListBySubscription.json" } }, - "x-ms-pageable":{ + "x-ms-pageable":{ "nextLinkName":"nextLink" } } @@ -104,16 +104,16 @@ ], "description": "Azure Firewall FQDN Tag Resource" }, - "AzureFirewallFqdnTagListResult":{ - "properties":{ - "value":{ + "AzureFirewallFqdnTagListResult":{ + "properties":{ + "value":{ "type":"array", - "items":{ + "items":{ "$ref":"#/definitions/AzureFirewallFqdnTag" }, "description":"List of Azure Firewall FQDN Tags in a resource group." }, - "nextLink":{ + "nextLink":{ "type":"string", "description":"URL to get the next set of results." } diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/ApplicationGatewayBackendHealthTest.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/ApplicationGatewayBackendHealthTest.json index b516a0b2be2d..f46829f978bb 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/ApplicationGatewayBackendHealthTest.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/ApplicationGatewayBackendHealthTest.json @@ -1,41 +1,41 @@ -{ - "parameters": { - "api-version": "2019-04-01", - "subscriptionId": "subid", - "resourceGroupName": "rg1", - "applicationGatewayName": "appgw", - "probeRequest": { - "protocol": "Http", - "pickHostNameFromBackendHttpSettings": true, - "path": "/", - "timeout": 30, - "backendPoolName": "MFAnalyticsPool", - "backendHttpSettingName": "MFPoolSettings" - } - }, - "responses": { - "200": { - "body": { - "backendAddressPool": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendaddressPools/MFAnalyticsPool" - }, - "backendHealthHttpSettings": { - "backendHttpSettings": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendHttpSettingsCollection/MFPoolSettings" - }, - "servers": [ - { - "address": "10.220.1.4", - "health": "Up" - }, - { - "address": "10.220.1.5", - "health": "Up" - } - ] - } - } - }, - "202": {} - } -} +{ + "parameters": { + "api-version": "2019-04-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "applicationGatewayName": "appgw", + "probeRequest": { + "protocol": "Http", + "pickHostNameFromBackendHttpSettings": true, + "path": "/", + "timeout": 30, + "backendPoolName": "MFAnalyticsPool", + "backendHttpSettingName": "MFPoolSettings" + } + }, + "responses": { + "200": { + "body": { + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendaddressPools/MFAnalyticsPool" + }, + "backendHealthHttpSettings": { + "backendHttpSettings": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendHttpSettingsCollection/MFPoolSettings" + }, + "servers": [ + { + "address": "10.220.1.4", + "health": "Up" + }, + { + "address": "10.220.1.5", + "health": "Up" + } + ] + } + } + }, + "202": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/ApplicationSecurityGroupUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/ApplicationSecurityGroupUpdateTags.json index bb7a9840d3ad..c7a001846e09 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/ApplicationSecurityGroupUpdateTags.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/ApplicationSecurityGroupUpdateTags.json @@ -1,33 +1,33 @@ -{ - "parameters" : { - "api-version": "2019-04-01", - "subscriptionId" : "subid", - "resourceGroupName" : "rg1", - "applicationSecurityGroupName" : "test-asg", - "location": "westus", - "parameters": { - "tags": { - "tag1": "value1", - "tag2": "value2" - } - } - }, - "responses" : { - "200" : { - "body" : { - "name" : "test-asg", - "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationSecurityGroups/test-asg", - "type" : "Microsoft.Network/applicationSecurityGroups", - "location" : "westus", - "tags": { - "tag1": "value1", - "tag2": "value2" - }, - "properties" : { - "provisioningState": "Succeeded", - "resourceGuid": "00000000-0000-0000-0000-000000000000" - } - } - } - } -} +{ + "parameters" : { + "api-version": "2019-04-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "applicationSecurityGroupName" : "test-asg", + "location": "westus", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses" : { + "200" : { + "body" : { + "name" : "test-asg", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationSecurityGroups/test-asg", + "type" : "Microsoft.Network/applicationSecurityGroups", + "location" : "westus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties" : { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/AvailableDelegationsResourceGroupGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/AvailableDelegationsResourceGroupGet.json index 5264e64dce32..160975ec0e01 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/AvailableDelegationsResourceGroupGet.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/AvailableDelegationsResourceGroupGet.json @@ -1,25 +1,25 @@ -{ - "parameters" : { - "api-version": "2019-04-01", - "location": "regionName", - "subscriptionId" : "subId", - "resourceGroupName" : "rg1" - }, - "responses" : { - "200" : { - "body" : { - "value": [ - { - "name": "Microsoft.Provider.resourceType", - "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/availableDelegations/Microsoft.Provider.resourceType", - "type": "Microsoft.Network/availableDelegations", - "serviceName": "Microsoft.Provider/resourceType", - "actions": [ - "Microsoft.Network/resource/action" - ] - } - ] - } - } - } -} +{ + "parameters" : { + "api-version": "2019-04-01", + "location": "regionName", + "subscriptionId" : "subId", + "resourceGroupName" : "rg1" + }, + "responses" : { + "200" : { + "body" : { + "value": [ + { + "name": "Microsoft.Provider.resourceType", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/availableDelegations/Microsoft.Provider.resourceType", + "type": "Microsoft.Network/availableDelegations", + "serviceName": "Microsoft.Provider/resourceType", + "actions": [ + "Microsoft.Network/resource/action" + ] + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/AvailableDelegationsSubscriptionGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/AvailableDelegationsSubscriptionGet.json index 350fd1fd7c2e..c43307c6cffd 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/AvailableDelegationsSubscriptionGet.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/AvailableDelegationsSubscriptionGet.json @@ -1,24 +1,24 @@ -{ - "parameters" : { - "api-version": "2019-04-01", - "location": "regionName", - "subscriptionId" : "subId" - }, - "responses" : { - "200" : { - "body" : { - "value": [ - { - "name": "Microsoft.Provider.resourceType", - "id": "/subscriptions/subId/providers/Microsoft.Network/availableDelegations/Microsoft.Provider.resourceType", - "type": "Microsoft.Network/availableDelegations", - "serviceName": "Microsoft.Provider/resourceType", - "actions": [ - "Microsoft.Network/resource/action" - ] - } - ] - } - } - } -} +{ + "parameters" : { + "api-version": "2019-04-01", + "location": "regionName", + "subscriptionId" : "subId" + }, + "responses" : { + "200" : { + "body" : { + "value": [ + { + "name": "Microsoft.Provider.resourceType", + "id": "/subscriptions/subId/providers/Microsoft.Network/availableDelegations/Microsoft.Provider.resourceType", + "type": "Microsoft.Network/availableDelegations", + "serviceName": "Microsoft.Provider/resourceType", + "actions": [ + "Microsoft.Network/resource/action" + ] + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/AzureFirewallFqdnTagsListBySubscription.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/AzureFirewallFqdnTagsListBySubscription.json index 3aefcda87429..1671836a657e 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/AzureFirewallFqdnTagsListBySubscription.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/AzureFirewallFqdnTagsListBySubscription.json @@ -1,22 +1,22 @@ -{ - "parameters":{ +{ + "parameters":{ "api-version":"2019-04-01", "subscriptionId":"subid" }, - "responses":{ - "200":{ - "body":{ - "value":[ - { + "responses":{ + "200":{ + "body":{ + "value":[ + { "name":"azfwfqdntag", "id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewallFqdnTags/azfwfqdntag", "type":"Microsoft.Network/azureFirewallFqdnTags", "etag":"w/\\00000000-0000-0000-0000-000000000000\\", "location":"West US", - "tags":{ + "tags":{ "key1":"value1" }, - "properties":{ + "properties":{ "provisioningState":"Succeeded", "fqdnTagName":"azfwfqdntag" } diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/AzureFirewallGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/AzureFirewallGet.json index 289d8bd815c8..ef078805abc2 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/AzureFirewallGet.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/AzureFirewallGet.json @@ -1,33 +1,33 @@ -{ - "parameters":{ +{ + "parameters":{ "api-version": "2019-04-01", "subscriptionId":"subid", "resourceGroupName":"rg1", "azureFirewallName":"azurefirewall" }, - "responses":{ - "200":{ - "body":{ + "responses":{ + "200":{ + "body":{ "name":"azurefirewall", "id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall", "type":"Microsoft.Network/azureFirewalls", "etag":"w/\\00000000-0000-0000-0000-000000000000\\", "location":"West US", - "tags":{ + "tags":{ "key1":"value1" }, - "properties":{ + "properties":{ "provisioningState":"Succeeded", "threatIntelMode": "Alert", - "ipConfigurations":[ - { + "ipConfigurations":[ + { "name":"azureFirewallIpConfiguration", "id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewallgw/ipConfigurations/azureFirewallIpConfiguration", "etag":"w/\\00000000-0000-0000-0000-000000000000\\", - "properties":{ + "properties":{ "provisioningState":"Succeeded", "privateIPAddress":"10.0.0.0", - "subnet":{ + "subnet":{ "id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/AzureFirewallSubnet" }, "publicIPAddress":{ @@ -36,28 +36,28 @@ } } ], - "applicationRuleCollections":[ - { + "applicationRuleCollections":[ + { "name":"apprulecoll", - "properties":{ + "properties":{ "priority":110, "action":{ "type": "Deny" }, - "rules":[ - { + "rules":[ + { "name":"rule1", "description":"Deny inbound rule", - "protocols":[ - { + "protocols":[ + { "protocolType":"Https", "port":443 } ], - "targetFqdns":[ + "targetFqdns":[ "www.test.com" ], - "sourceAddresses":[ + "sourceAddresses":[ "216.58.216.164", "10.0.0.0/24" ] @@ -66,28 +66,28 @@ } } ], - "natRuleCollections":[ - { + "natRuleCollections":[ + { "name":"natrulecoll", - "properties":{ + "properties":{ "priority":112, "action":{ "type":"Dnat" }, - "rules":[ - { + "rules":[ + { "name":"DNAT-HTTPS-traffic", "description":"D-NAT all outbound web traffic for inspection", - "sourceAddresses":[ + "sourceAddresses":[ "*" ], - "destinationAddresses":[ + "destinationAddresses":[ "1.2.3.4" ], - "destinationPorts":[ + "destinationPorts":[ "443" ], - "protocols":[ + "protocols":[ "TCP" ], "translatedAddress": "1.2.3.5", @@ -97,30 +97,30 @@ } } ], - "networkRuleCollections":[ - { + "networkRuleCollections":[ + { "name":"netrulecoll", - "properties":{ + "properties":{ "priority":112, "action":{ "type": "Deny" }, - "rules":[ - { + "rules":[ + { "name":"L4-traffic", "description":"Block traffic based on source IPs and ports", - "sourceAddresses":[ + "sourceAddresses":[ "192.168.1.1-192.168.1.12", "10.1.4.12-10.1.4.255" ], - "destinationPorts":[ + "destinationPorts":[ "443-444", "8443" ], - "destinationAddresses":[ + "destinationAddresses":[ "*" ], - "protocols":[ + "protocols":[ "TCP" ] } diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/AzureFirewallListByResourceGroup.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/AzureFirewallListByResourceGroup.json index b012f4844405..010540fc9b60 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/AzureFirewallListByResourceGroup.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/AzureFirewallListByResourceGroup.json @@ -1,34 +1,34 @@ -{ - "parameters":{ +{ + "parameters":{ "api-version": "2019-04-01", "subscriptionId":"subid", "resourceGroupName":"rg1" }, - "responses":{ - "200":{ - "body":{ - "value":[ - { + "responses":{ + "200":{ + "body":{ + "value":[ + { "name":"azurefirewall", "id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall", "type":"Microsoft.Network/azureFirewalls", "etag":"w/\\00000000-0000-0000-0000-000000000000\\", "location":"West US", - "tags":{ + "tags":{ "key1":"value1" }, - "properties":{ + "properties":{ "provisioningState":"Succeeded", "threatIntelMode": "Alert", - "ipConfigurations":[ - { + "ipConfigurations":[ + { "name":"azureFirewallIpConfiguration", "id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azfirewallgw/ipConfigurations/azureFirewallIpConfiguration", "etag":"w/\\00000000-0000-0000-0000-000000000000\\", - "properties":{ + "properties":{ "provisioningState":"Succeeded", "privateIPAddress":"10.0.0.0", - "subnet":{ + "subnet":{ "id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/AzureFirewallSubnet" }, "publicIPAddress":{ @@ -37,28 +37,28 @@ } } ], - "applicationRuleCollections":[ - { + "applicationRuleCollections":[ + { "name":"apprulecoll", - "properties":{ + "properties":{ "priority":110, "action":{ "type": "Deny" }, - "rules":[ - { + "rules":[ + { "name":"rule1", "description":"Deny inbound rule", - "protocols":[ - { + "protocols":[ + { "protocolType":"Https", "port":443 } ], - "targetFqdns":[ + "targetFqdns":[ "www.test.com" ], - "sourceAddresses":[ + "sourceAddresses":[ "216.58.216.164", "10.0.0.0/24" ] @@ -67,28 +67,28 @@ } } ], - "natRuleCollections":[ - { + "natRuleCollections":[ + { "name":"natrulecoll", - "properties":{ + "properties":{ "priority":112, "action":{ "type": "Dnat" }, - "rules":[ - { + "rules":[ + { "name":"DNAT-HTTPS-traffic", "description":"D-NAT all outbound web traffic for inspection", - "sourceAddresses":[ + "sourceAddresses":[ "*" ], - "destinationAddresses":[ + "destinationAddresses":[ "1.2.3.4" ], - "destinationPorts":[ + "destinationPorts":[ "443" ], - "protocols":[ + "protocols":[ "TCP" ], "translatedAddress": "1.2.3.5", @@ -98,30 +98,30 @@ } } ], - "networkRuleCollections":[ - { + "networkRuleCollections":[ + { "name":"netrulecoll", - "properties":{ + "properties":{ "priority":112, "action":{ "type": "Deny" }, - "rules":[ - { + "rules":[ + { "name":"L4-traffic", "description":"Block traffic based on source IPs and ports", - "sourceAddresses":[ + "sourceAddresses":[ "192.168.1.1-192.168.1.12", "10.1.4.12-10.1.4.255" ], - "destinationPorts":[ + "destinationPorts":[ "443-444", "8443" ], - "destinationAddresses":[ + "destinationAddresses":[ "*" ], - "protocols":[ + "protocols":[ "TCP" ] } diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/AzureFirewallListBySubscription.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/AzureFirewallListBySubscription.json index e77935daf6c3..f7fa80df8334 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/AzureFirewallListBySubscription.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/AzureFirewallListBySubscription.json @@ -1,33 +1,33 @@ -{ - "parameters":{ +{ + "parameters":{ "api-version": "2019-04-01", "subscriptionId":"subid" }, - "responses":{ - "200":{ - "body":{ - "value":[ - { + "responses":{ + "200":{ + "body":{ + "value":[ + { "name":"azurefirewall", "id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall", "type":"Microsoft.Network/azureFirewalls", "etag":"w/\\00000000-0000-0000-0000-000000000000\\", "location":"West US", - "tags":{ + "tags":{ "key1":"value1" }, - "properties":{ + "properties":{ "provisioningState":"Succeeded", "threatIntelMode": "Alert", - "ipConfigurations":[ - { + "ipConfigurations":[ + { "name":"azureFirewallIpConfiguration", "id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azfirewallgw/ipConfigurations/azureFirewallIpConfiguration", "etag":"w/\\00000000-0000-0000-0000-000000000000\\", - "properties":{ + "properties":{ "provisioningState":"Succeeded", "privateIPAddress":"10.0.0.0", - "subnet":{ + "subnet":{ "id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/AzureFirewallSubnet" }, "publicIPAddress":{ @@ -36,28 +36,28 @@ } } ], - "applicationRuleCollections":[ - { + "applicationRuleCollections":[ + { "name":"apprulecoll", - "properties":{ + "properties":{ "priority":110, "action":{ "type": "Deny" }, - "rules":[ - { + "rules":[ + { "name":"rule1", "description":"Deny inbound rule", - "protocols":[ - { + "protocols":[ + { "protocolType":"Https", "port":443 } ], - "targetFqdns":[ + "targetFqdns":[ "www.test.com" ], - "sourceAddresses":[ + "sourceAddresses":[ "216.58.216.164", "10.0.0.0/24" ] @@ -66,28 +66,28 @@ } } ], - "natRuleCollections":[ - { + "natRuleCollections":[ + { "name":"natrulecoll", - "properties":{ + "properties":{ "priority":112, "action":{ "type": "Dnat" }, - "rules":[ - { + "rules":[ + { "name":"DNAT-HTTPS-traffic", "description":"D-NAT all outbound web traffic for inspection", - "sourceAddresses":[ + "sourceAddresses":[ "*" ], - "destinationAddresses":[ + "destinationAddresses":[ "1.2.3.4" ], - "destinationPorts":[ + "destinationPorts":[ "443" ], - "protocols":[ + "protocols":[ "TCP" ], "translatedAddress": "1.2.3.5", @@ -97,30 +97,30 @@ } } ], - "networkRuleCollections":[ - { + "networkRuleCollections":[ + { "name":"netrulecoll", - "properties":{ + "properties":{ "priority":112, "action":{ "type": "Deny" }, - "rules":[ - { + "rules":[ + { "name":"L4-traffic", "description":"Block traffic based on source IPs and ports", - "sourceAddresses":[ + "sourceAddresses":[ "192.168.1.1-192.168.1.12", "10.1.4.12-10.1.4.255" ], - "destinationPorts":[ + "destinationPorts":[ "443-444", "8443" ], - "destinationAddresses":[ + "destinationAddresses":[ "*" ], - "protocols":[ + "protocols":[ "TCP" ] } diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/AzureFirewallPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/AzureFirewallPut.json index 293b3c7931f7..504406760452 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/AzureFirewallPut.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/AzureFirewallPut.json @@ -1,50 +1,50 @@ -{ - "parameters":{ +{ + "parameters":{ "api-version": "2019-04-01", "subscriptionId":"subid", "resourceGroupName":"rg1", "azureFirewallName":"azurefirewall", - "parameters":{ - "tags":{ + "parameters":{ + "tags":{ "key1":"value1" }, - "properties":{ + "properties":{ "threatIntelMode": "Alert", - "ipConfigurations":[ - { + "ipConfigurations":[ + { "name":"azureFirewallIpConfiguration", - "properties":{ - "subnet":{ + "properties":{ + "subnet":{ "id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/AzureFirewallSubnet" }, - "publicIPAddress":{ + "publicIPAddress":{ "id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pipName" } } } ], - "applicationRuleCollections":[ - { + "applicationRuleCollections":[ + { "name":"apprulecoll", - "properties":{ + "properties":{ "priority":110, "action":{ "type": "Deny" }, - "rules":[ - { + "rules":[ + { "name":"rule1", "description":"Deny inbound rule", - "protocols":[ - { + "protocols":[ + { "protocolType":"Https", "port":443 } ], - "targetFqdns":[ + "targetFqdns":[ "www.test.com" ], - "sourceAddresses":[ + "sourceAddresses":[ "216.58.216.164", "10.0.0.0/24" ] @@ -53,28 +53,28 @@ } } ], - "natRuleCollections":[ - { + "natRuleCollections":[ + { "name":"natrulecoll", - "properties":{ + "properties":{ "priority":112, "action":{ "type": "Dnat" }, - "rules":[ - { + "rules":[ + { "name":"DNAT-HTTPS-traffic", "description":"D-NAT all outbound web traffic for inspection", - "sourceAddresses":[ + "sourceAddresses":[ "*" ], - "destinationAddresses":[ + "destinationAddresses":[ "1.2.3.4" ], - "destinationPorts":[ + "destinationPorts":[ "443" ], - "protocols":[ + "protocols":[ "TCP" ], "translatedAddress": "1.2.3.5", @@ -84,30 +84,30 @@ } } ], - "networkRuleCollections":[ - { + "networkRuleCollections":[ + { "name":"netrulecoll", - "properties":{ + "properties":{ "priority":112, "action":{ "type": "Deny" }, - "rules":[ - { + "rules":[ + { "name":"L4-traffic", "description":"Block traffic based on source IPs and ports", - "sourceAddresses":[ + "sourceAddresses":[ "192.168.1.1-192.168.1.12", "10.1.4.12-10.1.4.255" ], - "destinationPorts":[ + "destinationPorts":[ "443-444", "8443" ], - "destinationAddresses":[ + "destinationAddresses":[ "*" ], - "protocols":[ + "protocols":[ "TCP" ] } @@ -118,29 +118,29 @@ } } }, - "responses":{ - "200":{ - "body":{ + "responses":{ + "200":{ + "body":{ "name":"azurefirewall", "id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall", "type":"Microsoft.Network/azureFirewalls", "etag":"w/\\00000000-0000-0000-0000-000000000000\\", "location":"West US", - "tags":{ + "tags":{ "key1":"value1" }, - "properties":{ + "properties":{ "provisioningState":"Succeeded", "threatIntelMode": "Alert", - "ipConfigurations":[ - { + "ipConfigurations":[ + { "name":"azureFirewallIpConfiguration", "id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azfirewallgw/ipConfigurations/azureFirewallIpConfiguration", "etag":"w/\\00000000-0000-0000-0000-000000000000\\", - "properties":{ + "properties":{ "provisioningState":"Succeeded", "privateIPAddress":"10.0.0.0", - "subnet":{ + "subnet":{ "id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/AzureFirewallSubnet" }, "publicIPAddress":{ @@ -149,28 +149,28 @@ } } ], - "applicationRuleCollections":[ - { + "applicationRuleCollections":[ + { "name":"apprulecoll", - "properties":{ + "properties":{ "priority":110, "action":{ "type": "Deny" }, - "rules":[ - { + "rules":[ + { "name":"rule1", "description":"Deny inbound rule", - "protocols":[ - { + "protocols":[ + { "protocolType":"Https", "port":443 } ], - "targetFqdns":[ + "targetFqdns":[ "www.test.com" ], - "sourceAddresses":[ + "sourceAddresses":[ "216.58.216.164", "10.0.0.0/24" ] @@ -179,28 +179,28 @@ } } ], - "natRuleCollections":[ - { + "natRuleCollections":[ + { "name":"natrulecoll", - "properties":{ + "properties":{ "priority":112, "action":{ "type": "Dnat" }, - "rules":[ - { + "rules":[ + { "name":"DNAT-HTTPS-traffic", "description":"D-NAT all outbound web traffic for inspection", - "sourceAddresses":[ + "sourceAddresses":[ "*" ], - "destinationAddresses":[ + "destinationAddresses":[ "1.2.3.4" ], - "destinationPorts":[ + "destinationPorts":[ "443" ], - "protocols":[ + "protocols":[ "TCP" ], "translatedAddress": "1.2.3.5", @@ -210,30 +210,30 @@ } } ], - "networkRuleCollections":[ - { + "networkRuleCollections":[ + { "name":"netrulecoll", - "properties":{ + "properties":{ "priority":112, "action":{ "type": "Deny" }, - "rules":[ - { + "rules":[ + { "name":"L4-traffic", "description":"Block traffic based on source IPs and ports", - "sourceAddresses":[ + "sourceAddresses":[ "192.168.1.1-192.168.1.12", "10.1.4.12-10.1.4.255" ], - "destinationPorts":[ + "destinationPorts":[ "443-444", "8443" ], - "destinationAddresses":[ + "destinationAddresses":[ "*" ], - "protocols":[ + "protocols":[ "TCP" ] } @@ -244,28 +244,28 @@ } } }, - "201":{ - "body":{ + "201":{ + "body":{ "name":"azurefirewall", "id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall", "type":"Microsoft.Network/azureFirewalls", "etag":"w/\\00000000-0000-0000-0000-000000000000\\", "location":"West US", - "tags":{ + "tags":{ "key1":"value1" }, - "properties":{ + "properties":{ "provisioningState":"Succeeded", "threatIntelMode": "Alert", - "ipConfigurations":[ - { + "ipConfigurations":[ + { "name":"azureFirewallIpConfiguration", "id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azfirewallgw/ipConfigurations/azureFirewallIpConfiguration", "etag":"w/\\00000000-0000-0000-0000-000000000000\\", - "properties":{ + "properties":{ "provisioningState":"Succeeded", "privateIPAddress":"10.0.0.0", - "subnet":{ + "subnet":{ "id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/AzureFirewallSubnet" }, "publicIPAddress":{ @@ -274,28 +274,28 @@ } } ], - "applicationRuleCollections":[ - { + "applicationRuleCollections":[ + { "name":"apprulecoll", - "properties":{ + "properties":{ "priority":110, "action":{ "type": "Deny" }, - "rules":[ - { + "rules":[ + { "name":"rule1", "description":"Deny inbound rule", - "protocols":[ - { + "protocols":[ + { "protocolType":"Https", "port":443 } ], - "targetFqdns":[ + "targetFqdns":[ "www.test.com" ], - "sourceAddresses":[ + "sourceAddresses":[ "216.58.216.164", "10.0.0.0/24" ] @@ -304,28 +304,28 @@ } } ], - "natRuleCollections":[ - { + "natRuleCollections":[ + { "name":"natrulecoll", - "properties":{ + "properties":{ "priority":112, "action":{ "type": "Dnat" }, - "rules":[ - { + "rules":[ + { "name":"DNAT-HTTPS-traffic", "description":"D-NAT all outbound web traffic for inspection", - "sourceAddresses":[ + "sourceAddresses":[ "*" ], - "destinationAddresses":[ + "destinationAddresses":[ "1.2.3.4" ], - "destinationPorts":[ + "destinationPorts":[ "443" ], - "protocols":[ + "protocols":[ "TCP" ], "translatedAddress": "1.2.3.5", @@ -335,30 +335,30 @@ } } ], - "networkRuleCollections":[ - { + "networkRuleCollections":[ + { "name":"netrulecoll", - "properties":{ + "properties":{ "priority":112, "action":{ "type": "Deny" }, - "rules":[ - { + "rules":[ + { "name":"L4-traffic", "description":"Block traffic based on source IPs and ports", - "sourceAddresses":[ + "sourceAddresses":[ "192.168.1.1-192.168.1.12", "10.1.4.12-10.1.4.255" ], - "destinationPorts":[ + "destinationPorts":[ "443-444", "8443" ], - "destinationAddresses":[ + "destinationAddresses":[ "*" ], - "protocols":[ + "protocols":[ "TCP" ] } diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/ExpressRouteCircuitAuthorizationCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/ExpressRouteCircuitAuthorizationCreate.json index 694d00290428..ac26b8db61a7 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/ExpressRouteCircuitAuthorizationCreate.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/ExpressRouteCircuitAuthorizationCreate.json @@ -1,5 +1,5 @@ -{ - "parameters":{ +{ + "parameters":{ "circuitName":"circuitName", "resourceGroupName":"rg1", "authorizationName":"authorizatinName", @@ -12,24 +12,24 @@ } } }, - "responses":{ - "201":{ - "body":{ + "responses":{ + "201":{ + "body":{ "name":"authorizationName", "id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName", "etag":"W/\"e22dd4b2-4c24-44cf-b702-70a472b62914\"", - "properties":{ + "properties":{ "provisioningState":"Updating", "authorizationUseStatus":"Available" } } }, - "200":{ - "body":{ + "200":{ + "body":{ "name":"authorizationName", "id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/authorizations/authorizationName", "etag":"W/\"e22dd4b2-4c24-44cf-b702-70a472b62914\"", - "properties":{ + "properties":{ "provisioningState":"Updating", "authorizationUseStatus":"Available" } diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/ExpressRouteCircuitAuthorizationDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/ExpressRouteCircuitAuthorizationDelete.json index 1bffdef428b1..f72eae7ae114 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/ExpressRouteCircuitAuthorizationDelete.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/ExpressRouteCircuitAuthorizationDelete.json @@ -1,19 +1,19 @@ -{ - "parameters":{ +{ + "parameters":{ "circuitName":"circuitName", "resourceGroupName":"rg1", "api-version": "2019-04-01", "subscriptionId":"subid", "authorizationName":"authorizationName" }, - "responses":{ - "200":{ + "responses":{ + "200":{ }, - "202":{ + "202":{ }, - "204":{ + "204":{ } } diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/ExpressRouteCircuitPeeringCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/ExpressRouteCircuitPeeringCreate.json index 49be9b55e8f0..34eb8122ef6e 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/ExpressRouteCircuitPeeringCreate.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/ExpressRouteCircuitPeeringCreate.json @@ -15,7 +15,7 @@ "ipv6PeeringConfig": { "primaryPeerAddressPrefix": "3FFE:FFFF:0:CD30::/126", "secondaryPeerAddressPrefix": "3FFE:FFFF:0:CD30::4/126" - } + } } } }, @@ -66,7 +66,7 @@ "state": "Enabled", "vlanId": 200, "gatewayManagerEtag": "", - "lastModifiedBy": "Customer", + "lastModifiedBy": "Customer", "ipv6PeeringConfig": { "primaryPeerAddressPrefix": "3FFE:FFFF:0:CD30::/126", "secondaryPeerAddressPrefix": "3FFE:FFFF:0:CD30::4/126", diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/ExpressRouteCrossConnectionBgpPeeringCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/ExpressRouteCrossConnectionBgpPeeringCreate.json index 79c69f5112e9..061deced429f 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/ExpressRouteCrossConnectionBgpPeeringCreate.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/ExpressRouteCrossConnectionBgpPeeringCreate.json @@ -15,7 +15,7 @@ "ipv6PeeringConfig": { "primaryPeerAddressPrefix": "3FFE:FFFF:0:CD30::/126", "secondaryPeerAddressPrefix": "3FFE:FFFF:0:CD30::4/126" - } + } } } }, diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/ExpressRouteCrossConnectionGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/ExpressRouteCrossConnectionGet.json index 418503bb1c22..52eb81538cc4 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/ExpressRouteCrossConnectionGet.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/ExpressRouteCrossConnectionGet.json @@ -12,7 +12,7 @@ "id": "/subscriptions/subid/resourceGroups/CrossConnection-SiliconValley/providers/Microsoft.Network/expressRouteCrossConnections/", "type": "Microsoft.Network/expressRouteCrossConnections", "location": "brazilsouth", - "etag": "W/\"c0e6477e-8150-4d4f-9bf6-bb10e6acb63a\"", + "etag": "W/\"c0e6477e-8150-4d4f-9bf6-bb10e6acb63a\"", "properties": { "provisioningState": "Enabled", "expressRouteCircuit": { @@ -25,7 +25,7 @@ "secondaryAzurePort": "bvtazureixp01", "sTag": 2, "serviceProviderProvisioningState": "NotProvisioned" - } + } } } } diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/ExpressRouteCrossConnectionUpdate.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/ExpressRouteCrossConnectionUpdate.json index d088d347ad20..26158b06a882 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/ExpressRouteCrossConnectionUpdate.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/ExpressRouteCrossConnectionUpdate.json @@ -29,7 +29,7 @@ "secondaryAzurePort": "bvtazureixp01", "sTag": 2, "serviceProviderProvisioningState": "NotProvisioned" - } + } } } } diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/ExpressRouteCrossConnectionUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/ExpressRouteCrossConnectionUpdateTags.json index 668f50f6f6ab..11cea3180626 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/ExpressRouteCrossConnectionUpdateTags.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/ExpressRouteCrossConnectionUpdateTags.json @@ -34,7 +34,7 @@ "secondaryAzurePort": "bvtazureixp01", "sTag": 2, "serviceProviderProvisioningState": "NotProvisioned" - } + } } } } diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/ExpressRouteCrossConnectionsRouteTable.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/ExpressRouteCrossConnectionsRouteTable.json index d203989d4d2e..50007f27c189 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/ExpressRouteCrossConnectionsRouteTable.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/ExpressRouteCrossConnectionsRouteTable.json @@ -23,7 +23,7 @@ "nextHop": "10.7.1.13" , "locPrf": "", "weight": 0, - "path": "65514" + "path": "65514" } ] } diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/InterfaceEndpointCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/InterfaceEndpointCreate.json index 7ca3804f0057..1bd32a27010d 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/InterfaceEndpointCreate.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/InterfaceEndpointCreate.json @@ -1,67 +1,67 @@ -{ - "parameters" : { - "api-version": "2019-04-01", - "subscriptionId" : "subId", - "resourceGroupName": "rg1", - "interfaceEndpointName": "testIe", - "parameters": { - "properties": { - "fqdn": "uniqueIdentifier.fqdn.windows.net", - "subnet": { - "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet" - }, - "endpointService": { - "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Provider/resourceType/resourceName" - } - } - } - }, - "responses" : { - "200" : { - "body" : { - "name" : "testIe", - "id" : "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/interfaceEndpoints/testIe", - "location" : "eastus", - "properties" : { - "fqdn": "uniqueIdentifier.fqdn.windows.net", - "provisioningState": "Succeded", - "owner": "User", - "endpointService": { - "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Provider/resourceType/resourceName" - }, - "subnet": { - "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet" - }, - "networkInterfaces": [ - { - "id": "/subscriptions/subId/resourceGroups/rg1/provders/Microsoft.Network/networkInterfaces/testIe.nic.abcd1234" - } - ] - } - } - }, - "201" : { - "body" : { - "name" : "testIe", - "id" : "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/interfaceEndpoints/testIe", - "location" : "eastus", - "properties" : { - "provisioningState" : "Succeeded", - "fqdn": "uniqueIdentifier.fqdn.windows.net", - "owner": "User", - "endpointService": { - "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Provider/resourceType/resourceName" - }, - "subnet": { - "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet" - }, - "networkInterfaces": [ - { - "id": "/subscriptions/subId/resourceGroups/rg1/provders/Microsoft.Network/networkInterfaces/testIe.nic.abcd1234" - } - ] - } - } - } - } -} +{ + "parameters" : { + "api-version": "2019-04-01", + "subscriptionId" : "subId", + "resourceGroupName": "rg1", + "interfaceEndpointName": "testIe", + "parameters": { + "properties": { + "fqdn": "uniqueIdentifier.fqdn.windows.net", + "subnet": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet" + }, + "endpointService": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Provider/resourceType/resourceName" + } + } + } + }, + "responses" : { + "200" : { + "body" : { + "name" : "testIe", + "id" : "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/interfaceEndpoints/testIe", + "location" : "eastus", + "properties" : { + "fqdn": "uniqueIdentifier.fqdn.windows.net", + "provisioningState": "Succeded", + "owner": "User", + "endpointService": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Provider/resourceType/resourceName" + }, + "subnet": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet" + }, + "networkInterfaces": [ + { + "id": "/subscriptions/subId/resourceGroups/rg1/provders/Microsoft.Network/networkInterfaces/testIe.nic.abcd1234" + } + ] + } + } + }, + "201" : { + "body" : { + "name" : "testIe", + "id" : "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/interfaceEndpoints/testIe", + "location" : "eastus", + "properties" : { + "provisioningState" : "Succeeded", + "fqdn": "uniqueIdentifier.fqdn.windows.net", + "owner": "User", + "endpointService": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Provider/resourceType/resourceName" + }, + "subnet": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet" + }, + "networkInterfaces": [ + { + "id": "/subscriptions/subId/resourceGroups/rg1/provders/Microsoft.Network/networkInterfaces/testIe.nic.abcd1234" + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/InterfaceEndpointDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/InterfaceEndpointDelete.json index c29aaae855bf..02080fd16c74 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/InterfaceEndpointDelete.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/InterfaceEndpointDelete.json @@ -1,13 +1,13 @@ -{ - "parameters" : { - "api-version": "2019-04-01", - "subscriptionId" : "subId", - "resourceGroupName": "rg1", - "interfaceEndpointName": "testIe" - }, - "responses" : { - "200" : { }, - "202" : { }, - "204" : { } - } -} +{ + "parameters" : { + "api-version": "2019-04-01", + "subscriptionId" : "subId", + "resourceGroupName": "rg1", + "interfaceEndpointName": "testIe" + }, + "responses" : { + "200" : { }, + "202" : { }, + "204" : { } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/InterfaceEndpointGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/InterfaceEndpointGet.json index 82d5d4f4c9c7..b21e58da2e3a 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/InterfaceEndpointGet.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/InterfaceEndpointGet.json @@ -1,34 +1,34 @@ -{ - "parameters" : { - "api-version": "2019-04-01", - "subscriptionId" : "subId", - "resourceGroupName" : "rg1", - "interfaceEndpointName" : "testIe" - }, - "responses" : { - "200" : { - "body" : { - "name" : "testIe", - "id" : "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/interfaceEndpoints/testIe", - "type" : "Microsoft.Network/interfaceEndpoints", - "location" : "eastus", - "properties" : { - "provisioningState" : "Succeeded", - "fqdn": "uniqueIdentifier.fqdn.windows.net", - "owner": "User", - "endpointService": { - "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Provider/resourceType/resourceName" - }, - "subnet": { - "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet" - }, - "networkInterfaces": [ - { - "id": "/subscriptions/subId/resourceGroups/rg1/provders/Microsoft.Network/networkInterfaces/testIe.nic.abcd1234" - } - ] - } - } - } - } -} +{ + "parameters" : { + "api-version": "2019-04-01", + "subscriptionId" : "subId", + "resourceGroupName" : "rg1", + "interfaceEndpointName" : "testIe" + }, + "responses" : { + "200" : { + "body" : { + "name" : "testIe", + "id" : "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/interfaceEndpoints/testIe", + "type" : "Microsoft.Network/interfaceEndpoints", + "location" : "eastus", + "properties" : { + "provisioningState" : "Succeeded", + "fqdn": "uniqueIdentifier.fqdn.windows.net", + "owner": "User", + "endpointService": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Provider/resourceType/resourceName" + }, + "subnet": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet" + }, + "networkInterfaces": [ + { + "id": "/subscriptions/subId/resourceGroups/rg1/provders/Microsoft.Network/networkInterfaces/testIe.nic.abcd1234" + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/InterfaceEndpointList.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/InterfaceEndpointList.json index 538451e82db5..f44a025267d0 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/InterfaceEndpointList.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/InterfaceEndpointList.json @@ -1,59 +1,59 @@ -{ - "parameters" : { - "api-version": "2019-04-01", - "subscriptionId" : "subId", - "resourceGroupName" : "rg1" - }, - "responses" : { - "200" : { - "body" : { - "value": [ - { - "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/interfaceEndpoints/ie1", - "name": "ie1", - "type": "Microsoft.Network/interfaceEndpoints", - "location": "eastus", - "properties" : { - "provisioningState" : "Succeeded", - "fqdn": "uniqueIdentifier.fqdn.windows.net", - "owner": "User", - "endpointService": { - "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Provider/resourceType/resourceName" - }, - "subnet": { - "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet" - }, - "networkInterfaces": [ - { - "id": "/subscriptions/subId/resourceGroups/rg1/provders/Microsoft.Network/networkInterfaces/ie1.nic.abcd1234" - } - ] - } - }, - { - "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/interfaceEndpoints/ie2", - "name": "ie2", - "type": "Microsoft.Network/interfaceEndpoints", - "location": "eastus", - "properties" : { - "provisioningState" : "Succeeded", - "fqdn": "alsoUnique.fqdn.windows.net", - "owner": "User", - "endpointService": { - "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Provider/resourceType/otherResourceName" - }, - "subnet": { - "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet" - }, - "networkInterfaces": [ - { - "id": "/subscriptions/subId/resourceGroups/rg1/provders/Microsoft.Network/networkInterfaces/ie2.nic.zyxw9876" - } - ] - } - } - ] - } - } - } -} +{ + "parameters" : { + "api-version": "2019-04-01", + "subscriptionId" : "subId", + "resourceGroupName" : "rg1" + }, + "responses" : { + "200" : { + "body" : { + "value": [ + { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/interfaceEndpoints/ie1", + "name": "ie1", + "type": "Microsoft.Network/interfaceEndpoints", + "location": "eastus", + "properties" : { + "provisioningState" : "Succeeded", + "fqdn": "uniqueIdentifier.fqdn.windows.net", + "owner": "User", + "endpointService": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Provider/resourceType/resourceName" + }, + "subnet": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet" + }, + "networkInterfaces": [ + { + "id": "/subscriptions/subId/resourceGroups/rg1/provders/Microsoft.Network/networkInterfaces/ie1.nic.abcd1234" + } + ] + } + }, + { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/interfaceEndpoints/ie2", + "name": "ie2", + "type": "Microsoft.Network/interfaceEndpoints", + "location": "eastus", + "properties" : { + "provisioningState" : "Succeeded", + "fqdn": "alsoUnique.fqdn.windows.net", + "owner": "User", + "endpointService": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Provider/resourceType/otherResourceName" + }, + "subnet": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet" + }, + "networkInterfaces": [ + { + "id": "/subscriptions/subId/resourceGroups/rg1/provders/Microsoft.Network/networkInterfaces/ie2.nic.zyxw9876" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/InterfaceEndpointListAll.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/InterfaceEndpointListAll.json index b74112ac752f..2c8dcacd8b3b 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/InterfaceEndpointListAll.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/InterfaceEndpointListAll.json @@ -1,80 +1,80 @@ -{ - "parameters" : { - "api-version": "2019-04-01", - "subscriptionId" : "subId" - }, - "responses" : { - "200" : { - "body" : { - "value": [ - { - "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/interfaceEndpoints/ie1", - "name": "ie1", - "type": "Microsoft.Network/interfaceEndpoints", - "location": "eastus", - "properties" : { - "provisioningState" : "Succeeded", - "fqdn": "uniqueIdentifier.fqdn.windows.net", - "owner": "User", - "endpointService": { - "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Provider/resourceType/resourceName" - }, - "subnet": { - "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet" - }, - "networkInterfaces": [ - { - "id": "/subscriptions/subId/resourceGroups/rg1/provders/Microsoft.Network/networkInterfaces/ie1.nic.abcd1234" - } - ] - } - }, - { - "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/interfaceEndpoints/ie2", - "name": "ie2", - "type": "Microsoft.Network/interfaceEndpoints", - "location": "eastus", - "properties" : { - "provisioningState" : "Succeeded", - "fqdn": "alsoUnique.fqdn.windows.net", - "owner": "User", - "endpointService": { - "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Provider/resourceType/otherResourceName" - }, - "subnet": { - "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet" - }, - "networkInterfaces": [ - { - "id": "/subscriptions/subId/resourceGroups/rg1/provders/Microsoft.Network/networkInterfaces/ie2.nic.zyxw9876" - } - ] - } - }, - { - "id": "/subscriptions/subId/resourceGroups/rg2/providers/Microsoft.Network/interfaceEndpoints/ie1", - "name": "ie1", - "type": "Microsoft.Network/interfaceEndpoints", - "location": "eastus", - "properties" : { - "provisioningState" : "Succeeded", - "fqdn": "stillVeryUnique.fqdn.windows.net", - "owner": "User", - "endpointService": { - "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Provider/resourceType/resourceName" - }, - "subnet": { - "id": "/subscriptions/subId/resourceGroups/rg2/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet" - }, - "networkInterfaces": [ - { - "id": "/subscriptions/subId/resourceGroups/rg2/provders/Microsoft.Network/networkInterfaces/ie1.nic.efgh5463" - } - ] - } - } - ] - } - } - } -} +{ + "parameters" : { + "api-version": "2019-04-01", + "subscriptionId" : "subId" + }, + "responses" : { + "200" : { + "body" : { + "value": [ + { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/interfaceEndpoints/ie1", + "name": "ie1", + "type": "Microsoft.Network/interfaceEndpoints", + "location": "eastus", + "properties" : { + "provisioningState" : "Succeeded", + "fqdn": "uniqueIdentifier.fqdn.windows.net", + "owner": "User", + "endpointService": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Provider/resourceType/resourceName" + }, + "subnet": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet" + }, + "networkInterfaces": [ + { + "id": "/subscriptions/subId/resourceGroups/rg1/provders/Microsoft.Network/networkInterfaces/ie1.nic.abcd1234" + } + ] + } + }, + { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/interfaceEndpoints/ie2", + "name": "ie2", + "type": "Microsoft.Network/interfaceEndpoints", + "location": "eastus", + "properties" : { + "provisioningState" : "Succeeded", + "fqdn": "alsoUnique.fqdn.windows.net", + "owner": "User", + "endpointService": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Provider/resourceType/otherResourceName" + }, + "subnet": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet" + }, + "networkInterfaces": [ + { + "id": "/subscriptions/subId/resourceGroups/rg1/provders/Microsoft.Network/networkInterfaces/ie2.nic.zyxw9876" + } + ] + } + }, + { + "id": "/subscriptions/subId/resourceGroups/rg2/providers/Microsoft.Network/interfaceEndpoints/ie1", + "name": "ie1", + "type": "Microsoft.Network/interfaceEndpoints", + "location": "eastus", + "properties" : { + "provisioningState" : "Succeeded", + "fqdn": "stillVeryUnique.fqdn.windows.net", + "owner": "User", + "endpointService": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Provider/resourceType/resourceName" + }, + "subnet": { + "id": "/subscriptions/subId/resourceGroups/rg2/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet" + }, + "networkInterfaces": [ + { + "id": "/subscriptions/subId/resourceGroups/rg2/provders/Microsoft.Network/networkInterfaces/ie1.nic.efgh5463" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/LoadBalancerGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/LoadBalancerGet.json index cfa3580ddd96..08f707e8e4e8 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/LoadBalancerGet.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/LoadBalancerGet.json @@ -14,7 +14,7 @@ "location": "westus", "sku": { "name": "Basic" - }, + }, "properties": { "provisioningState": "Succeeded", "frontendIPConfigurations": [ diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/NatGatewayDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/NatGatewayDelete.json index 490674d46bef..4370faeada7a 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/NatGatewayDelete.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/NatGatewayDelete.json @@ -1,13 +1,13 @@ { - "parameters" : { - "api-version": "2019-04-01", - "subscriptionId" : "subid", - "resourceGroupName": "rg1", - "natGatewayName": "test-natGateway" - }, - "responses" : { - "200" : { }, - "202" : { }, - "204" : { } - } + "parameters" : { + "api-version": "2019-04-01", + "subscriptionId" : "subid", + "resourceGroupName": "rg1", + "natGatewayName": "test-natGateway" + }, + "responses" : { + "200" : { }, + "202" : { }, + "204" : { } } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/NatGatewayGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/NatGatewayGet.json index 03737fe9fbde..7a17b8848123 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/NatGatewayGet.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/NatGatewayGet.json @@ -1,41 +1,41 @@ { - "parameters" : { - "api-version": "2019-04-01", - "subscriptionId" : "subid", - "resourceGroupName": "rg1", - "natGatewayName": "test-natGateway" - }, - "responses" : { - "200" : { - "body" : { - "name" : "test-natGateway", - "sku": { - "name": "Standard" - }, - "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/natGateways/test-natGateway", - "location" : "westus", - "properties" : { - "idleTimeoutInMinutes" : 5, - "provisioningState": "Succeeded", - "publicIpAddresses": [ - { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/PublicIpAddress1" - } - ], - "publicIpPrefixes": [ - { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPPrefixes/PublicIpPrefix1" - } - ], - "subnets": [ - { - "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1" - } - ] - }, - "type" : "Microsoft.Network/natGateways" - } + "parameters" : { + "api-version": "2019-04-01", + "subscriptionId" : "subid", + "resourceGroupName": "rg1", + "natGatewayName": "test-natGateway" + }, + "responses" : { + "200" : { + "body" : { + "name" : "test-natGateway", + "sku": { + "name": "Standard" + }, + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/natGateways/test-natGateway", + "location" : "westus", + "properties" : { + "idleTimeoutInMinutes" : 5, + "provisioningState": "Succeeded", + "publicIpAddresses": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/PublicIpAddress1" + } + ], + "publicIpPrefixes": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPPrefixes/PublicIpPrefix1" + } + ], + "subnets": [ + { + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1" + } + ] + }, + "type" : "Microsoft.Network/natGateways" } } } - +} + diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/NatGatewayList.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/NatGatewayList.json index 23ec463b87d8..9f3470643481 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/NatGatewayList.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/NatGatewayList.json @@ -1,72 +1,72 @@ { - "parameters" : { - "api-version": "2019-04-01", - "subscriptionId" : "subid", - "resourceGroupName" : "rg1" - }, - "responses" : { - "200" : { - "body" : { - "value" : [ - { - "name" : "test-natGateway", - "sku": { - "name": "Standard" - }, - "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/natGateway/test-natGateway", - "location" : "westus", - "properties" : { - "idleTimeoutInMinutes" : 5, - "provisioningState": "Succeeded", - "publicIpAddresses": [ - { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/PublicIpAddress1" - } - ], - "publicIpPrefixes": [ - { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPPrefixes/PublicIpPrefix1" - } - ], - "subnets": [ - { - "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1" - } - ] - }, - "type" : "Microsoft.Network/natGateways" - }, - { - "name" : "test-natGateway2", - "sku": { - "name": "Standard" - }, - "id" : "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/natGateway/test-natGateway2", - "location" : "westus", - "properties" : { - "idleTimeoutInMinutes" : 5, - "provisioningState": "Succeeded", - "publicIpAddresses": [ - { - "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/publicIPAddresses/PublicIpAddress1" - } - ], - "publicIpPrefixes": [ - { - "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/publicIPPrefixes/PublicIpPrefix1" - } - ], - "subnets": [ - { - "id" : "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1" - } - ] - }, - "type" : "Microsoft.Network/natGateways" - } - ] - } + "parameters" : { + "api-version": "2019-04-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1" + }, + "responses" : { + "200" : { + "body" : { + "value" : [ + { + "name" : "test-natGateway", + "sku": { + "name": "Standard" + }, + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/natGateway/test-natGateway", + "location" : "westus", + "properties" : { + "idleTimeoutInMinutes" : 5, + "provisioningState": "Succeeded", + "publicIpAddresses": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/PublicIpAddress1" + } + ], + "publicIpPrefixes": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPPrefixes/PublicIpPrefix1" + } + ], + "subnets": [ + { + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1" + } + ] + }, + "type" : "Microsoft.Network/natGateways" + }, + { + "name" : "test-natGateway2", + "sku": { + "name": "Standard" + }, + "id" : "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/natGateway/test-natGateway2", + "location" : "westus", + "properties" : { + "idleTimeoutInMinutes" : 5, + "provisioningState": "Succeeded", + "publicIpAddresses": [ + { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/publicIPAddresses/PublicIpAddress1" + } + ], + "publicIpPrefixes": [ + { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/publicIPPrefixes/PublicIpPrefix1" + } + ], + "subnets": [ + { + "id" : "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1" + } + ] + }, + "type" : "Microsoft.Network/natGateways" + } + ] } } } - +} + diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/NatGatewayListAll.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/NatGatewayListAll.json index 4c57a054dd3f..39c70886e381 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/NatGatewayListAll.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/NatGatewayListAll.json @@ -1,71 +1,71 @@ { - "parameters" : { - "api-version": "2019-04-01", - "subscriptionId" : "subid" - }, - "responses" : { - "200" : { - "body" : { - "value" : [ - { - "name" : "test-natGateway", - "sku": { - "name": "Standard" - }, - "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/natGateways/test-natGateway", - "location" : "westus", - "properties" : { - "idleTimeoutInMinutes" : 5, - "provisioningState": "Succeeded", - "publicIpAddresses": [ - { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/PublicIpAddress1" - } - ], - "publicIpPrefixes": [ - { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPPrefixes/PublicIpPrefix1" - } - ], - "subnets": [ - { - "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1" - } - ] - }, - "type" : "Microsoft.Network/natGateways" - }, - { - "name" : "test-natGateway2", - "sku": { - "name": "Standard" - }, - "id" : "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/natGatewayes/test-natGateway2", - "location" : "westus", - "properties" : { - "idleTimeoutInMinutes" : 5, - "provisioningState": "Succeeded", - "publicIpAddresses": [ - { - "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/publicIPAddresses/PublicIpAddress1" - } - ], - "publicIpPrefixes": [ - { - "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/publicIPPrefixes/PublicIpPrefix1" - } - ], - "subnets": [ - { - "id" : "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1" - } - ] - }, - "type" : "Microsoft.Network/natGateways" - } - ] - } + "parameters" : { + "api-version": "2019-04-01", + "subscriptionId" : "subid" + }, + "responses" : { + "200" : { + "body" : { + "value" : [ + { + "name" : "test-natGateway", + "sku": { + "name": "Standard" + }, + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/natGateways/test-natGateway", + "location" : "westus", + "properties" : { + "idleTimeoutInMinutes" : 5, + "provisioningState": "Succeeded", + "publicIpAddresses": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/PublicIpAddress1" + } + ], + "publicIpPrefixes": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPPrefixes/PublicIpPrefix1" + } + ], + "subnets": [ + { + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1" + } + ] + }, + "type" : "Microsoft.Network/natGateways" + }, + { + "name" : "test-natGateway2", + "sku": { + "name": "Standard" + }, + "id" : "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/natGatewayes/test-natGateway2", + "location" : "westus", + "properties" : { + "idleTimeoutInMinutes" : 5, + "provisioningState": "Succeeded", + "publicIpAddresses": [ + { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/publicIPAddresses/PublicIpAddress1" + } + ], + "publicIpPrefixes": [ + { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/publicIPPrefixes/PublicIpPrefix1" + } + ], + "subnets": [ + { + "id" : "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1" + } + ] + }, + "type" : "Microsoft.Network/natGateways" + } + ] } } } - +} + diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/NetworkInterfaceTapConfigurationCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/NetworkInterfaceTapConfigurationCreate.json index 72da7d208229..8efa00f8ec8b 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/NetworkInterfaceTapConfigurationCreate.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/NetworkInterfaceTapConfigurationCreate.json @@ -39,7 +39,7 @@ "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworkTaps/testvtap" }, "provisioningState": "Succeded" - } + } } } } diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/NetworkInterfaceTapConfigurationGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/NetworkInterfaceTapConfigurationGet.json index 3e15f5c0607d..5ba6da7b5f34 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/NetworkInterfaceTapConfigurationGet.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/NetworkInterfaceTapConfigurationGet.json @@ -8,7 +8,7 @@ }, "responses": { "200": { - "body": + "body": { "name": "tapConfiguration1", "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/networkInterfaces/mynic/tapConfigurations/tapConfiguration1", diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/NetworkProfileDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/NetworkProfileDelete.json index b11d84c1c997..03a01849c439 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/NetworkProfileDelete.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/NetworkProfileDelete.json @@ -1,12 +1,12 @@ { "parameters": { - "api-version": "2019-04-01", + "api-version": "2019-04-01", "subscriptionId": "subid", "resourceGroupName": "rg1", "networkProfileName": "networkProfile1" }, "responses": { - "200": { }, + "200": { }, "202": { }, "204": { } } diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/NetworkWatcherAzureReachabilityReportGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/NetworkWatcherAzureReachabilityReportGet.json index 8d8424e26b87..c5055b177385 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/NetworkWatcherAzureReachabilityReportGet.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/NetworkWatcherAzureReachabilityReportGet.json @@ -42,9 +42,9 @@ }, { "timeStamp": "2017-09-09T00:00:00Z", - "score": 94 + "score": 94 } - ] + ] } ] } @@ -71,9 +71,9 @@ }, { "timeStamp": "2017-09-09T00:00:00Z", - "score": 94 + "score": 94 } - ] + ] } ] } diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/NetworkWatcherNetworkConfigurationDiagnostic.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/NetworkWatcherNetworkConfigurationDiagnostic.json index 8480c356f49c..c8b51b811798 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/NetworkWatcherNetworkConfigurationDiagnostic.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/NetworkWatcherNetworkConfigurationDiagnostic.json @@ -7,22 +7,22 @@ "parameters" : { "targetResourceId" : "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Compute/virtualMachines/vm1", "profiles": [ - { - "direction" : "Inbound", - "protocol" : "TCP", - "source" : "10.1.0.4", - "destination" : "12.11.12.14", - "destinationPort" : "12100" - } - ] + { + "direction" : "Inbound", + "protocol" : "TCP", + "source" : "10.1.0.4", + "destination" : "12.11.12.14", + "destinationPort" : "12100" + } + ] } }, "responses" : { "200" : { "body" : { - "results": [ - { - "profile": { + "results": [ + { + "profile": { "direction": "Inbound", "protocol": "TCP", "source": "10.1.0.4", @@ -34,7 +34,7 @@ "evaluatedNetworkSecurityGroups": [ { "networkSecurityGroupId": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkSecurityGroups/nsg1", - "appliedTo": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualNetworks/vnet/subnets/AppSubnet", + "appliedTo": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualNetworks/vnet/subnets/AppSubnet", "matchedRule": { "ruleName": "UserRule_fe_rule", "action": "Allow" @@ -83,8 +83,8 @@ ] }, { - "networkSecurityGroupId": "/subscriptions/61cc8a98-a8be-4bfe-a04e-0b461f93fe35/resourceGroups/NwRgCentralUSEUAP_copy/providers/Microsoft.Network/networkSecurityGroups/AppNSG", - "appliedTo": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualNetworks/vnet/networkInterfaces/nic", + "networkSecurityGroupId": "/subscriptions/61cc8a98-a8be-4bfe-a04e-0b461f93fe35/resourceGroups/NwRgCentralUSEUAP_copy/providers/Microsoft.Network/networkSecurityGroups/AppNSG", + "appliedTo": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualNetworks/vnet/networkInterfaces/nic", "matchedRule": { "ruleName": "UserRule_fe_rule", "action": "Allow" @@ -108,9 +108,9 @@ }, "202" : { "body" : { - "results": [ - { - "profile": { + "results": [ + { + "profile": { "direction": "Inbound", "protocol": "TCP", "source": "10.1.0.4", @@ -122,7 +122,7 @@ "evaluatedNetworkSecurityGroups": [ { "networkSecurityGroupId": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkSecurityGroups/nsg1", - "appliedTo": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualNetworks/vnet/subnets/AppSubnet", + "appliedTo": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualNetworks/vnet/subnets/AppSubnet", "matchedRule": { "ruleName": "UserRule_fe_rule", "action": "Allow" @@ -171,8 +171,8 @@ ] }, { - "networkSecurityGroupId": "/subscriptions/61cc8a98-a8be-4bfe-a04e-0b461f93fe35/resourceGroups/NwRgCentralUSEUAP_copy/providers/Microsoft.Network/networkSecurityGroups/AppNSG", - "appliedTo": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualNetworks/vnet/networkInterfaces/nic", + "networkSecurityGroupId": "/subscriptions/61cc8a98-a8be-4bfe-a04e-0b461f93fe35/resourceGroups/NwRgCentralUSEUAP_copy/providers/Microsoft.Network/networkSecurityGroups/AppNSG", + "appliedTo": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualNetworks/vnet/networkInterfaces/nic", "matchedRule": { "ruleName": "UserRule_fe_rule", "action": "Allow" diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/NetworkWatcherSecurityGroupViewGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/NetworkWatcherSecurityGroupViewGet.json index 1baf2edff911..e5f6b59ebfb9 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/NetworkWatcherSecurityGroupViewGet.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/NetworkWatcherSecurityGroupViewGet.json @@ -54,7 +54,7 @@ "direction" : "Inbound" } } - ], + ], "effectiveSecurityRules" : [ { "name" : "DefaultOutboundDenyAll", @@ -118,7 +118,7 @@ "direction" : "Inbound" } } - ], + ], "effectiveSecurityRules" : [ { "name" : "DefaultOutboundDenyAll", diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/NetworkWatcherTroubleshootGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/NetworkWatcherTroubleshootGet.json index 2a26b53437d8..8aa58a202139 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/NetworkWatcherTroubleshootGet.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/NetworkWatcherTroubleshootGet.json @@ -19,24 +19,24 @@ "endTime" : "2017-01-12T00:20:09.914Z", "code" : "UnHealthy", "results" : [ - { - "id": "000000", + { + "id": "000000", "reasonType" : "VipUnResponsive", - "summary": "We are sorry, your VPN gateway is unreachable from the Internet", - "detail": "During this time S2S VPN tunnels to on premises sites or other Azure virtual networks will be disconnected", - "recommendedActions": [ - { - "actionText": "Verify if there is a network security group (NSG) applied to the GatewaySubnet", + "summary": "We are sorry, your VPN gateway is unreachable from the Internet", + "detail": "During this time S2S VPN tunnels to on premises sites or other Azure virtual networks will be disconnected", + "recommendedActions": [ + { + "actionText": "Verify if there is a network security group (NSG) applied to the GatewaySubnet", "actionUri": "https://docs.microsoft.com/en-us/azure/virtual-network/virtual-networks-create-nsg-arm-pportal", - "actionUriText": "Verify" - }, - { - "actionText": "If your VPN gateway isn't up and running by the expected resolution time, contact support", - "actionUri": "http://azure.microsoft.com/support", + "actionUriText": "Verify" + }, + { + "actionText": "If your VPN gateway isn't up and running by the expected resolution time, contact support", + "actionUri": "http://azure.microsoft.com/support", "actionUriText": "contact support" - } - ] - } + } + ] + } ] } }, @@ -46,24 +46,24 @@ "endTime" : "2017-01-12T00:20:09.914Z", "code" : "UnHealthy", "results" : [ - { - "id": "000000", + { + "id": "000000", "reasonType" : "VipUnResponsive", - "summary": "We are sorry, your VPN gateway is unreachable from the Internet", - "detail": "During this time S2S VPN tunnels to on premises sites or other Azure virtual networks will be disconnected", - "recommendedActions": [ - { - "actionText": "Verify if there is a network security group (NSG) applied to the GatewaySubnet", + "summary": "We are sorry, your VPN gateway is unreachable from the Internet", + "detail": "During this time S2S VPN tunnels to on premises sites or other Azure virtual networks will be disconnected", + "recommendedActions": [ + { + "actionText": "Verify if there is a network security group (NSG) applied to the GatewaySubnet", "actionUri": "https://docs.microsoft.com/en-us/azure/virtual-network/virtual-networks-create-nsg-arm-pportal", - "actionUriText": "Verify" - }, - { - "actionText": "If your VPN gateway isn't up and running by the expected resolution time, contact support", - "actionUri": "http://azure.microsoft.com/support", + "actionUriText": "Verify" + }, + { + "actionText": "If your VPN gateway isn't up and running by the expected resolution time, contact support", + "actionUri": "http://azure.microsoft.com/support", "actionUriText": "contact support" - } - ] - } + } + ] + } ] } } diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/NetworkWatcherTroubleshootResultQuery.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/NetworkWatcherTroubleshootResultQuery.json index a298c5bddffe..b92f114e4acb 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/NetworkWatcherTroubleshootResultQuery.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/NetworkWatcherTroubleshootResultQuery.json @@ -15,24 +15,24 @@ "endTime" : "2017-01-12T00:20:09.914Z", "code" : "UnHealthy", "results" : [ - { - "id": "000000", + { + "id": "000000", "reasonType" : "VipUnResponsive", - "summary" : "We are sorry, your VPN gateway is unreachable from the Internet", - "detail" : "During this time S2S VPN tunnels to on premises sites or other Azure virtual networks will be disconnected", - "recommendedActions" : [ - { - "actionText" : "Verify if there is a network security group (NSG) applied to the GatewaySubnet", + "summary" : "We are sorry, your VPN gateway is unreachable from the Internet", + "detail" : "During this time S2S VPN tunnels to on premises sites or other Azure virtual networks will be disconnected", + "recommendedActions" : [ + { + "actionText" : "Verify if there is a network security group (NSG) applied to the GatewaySubnet", "actionUri" : "https://docs.microsoft.com/en-us/azure/virtual-network/virtual-networks-create-nsg-arm-pportal", - "actionUriText" : "Verify" - }, - { - "actionText" : "If your VPN gateway isn't up and running by the expected resolution time, contact support", - "actionUri" : "http://azure.microsoft.com/support", + "actionUriText" : "Verify" + }, + { + "actionText" : "If your VPN gateway isn't up and running by the expected resolution time, contact support", + "actionUri" : "http://azure.microsoft.com/support", "actionUriText" : "contact support" - } - ] - } + } + ] + } ] } }, @@ -42,24 +42,24 @@ "endTime" : "2017-01-12T00:20:09.914Z", "code" : "UnHealthy", "results" : [ - { - "id" : "000000", + { + "id" : "000000", "reasonType" : "VipUnResponsive", - "summary" : "We are sorry, your VPN gateway is unreachable from the Internet", - "detail" : "During this time S2S VPN tunnels to on premises sites or other Azure virtual networks will be disconnected", - "recommendedActions" : [ - { - "actionText" : "Verify if there is a network security group (NSG) applied to the GatewaySubnet", + "summary" : "We are sorry, your VPN gateway is unreachable from the Internet", + "detail" : "During this time S2S VPN tunnels to on premises sites or other Azure virtual networks will be disconnected", + "recommendedActions" : [ + { + "actionText" : "Verify if there is a network security group (NSG) applied to the GatewaySubnet", "actionUri" : "https://docs.microsoft.com/en-us/azure/virtual-network/virtual-networks-create-nsg-arm-pportal", - "actionUriText" : "Verify" - }, - { - "actionText" : "If your VPN gateway isn't up and running by the expected resolution time, contact support", - "actionUri" : "http://azure.microsoft.com/support", + "actionUriText" : "Verify" + }, + { + "actionText" : "If your VPN gateway isn't up and running by the expected resolution time, contact support", + "actionUri" : "http://azure.microsoft.com/support", "actionUriText" : "contact support" - } - ] - } + } + ] + } ] } } diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/P2SVpnGatewayGenerateVpnProfile.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/P2SVpnGatewayGenerateVpnProfile.json index 4e4edfa96896..bb7b8b3548ed 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/P2SVpnGatewayGenerateVpnProfile.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/P2SVpnGatewayGenerateVpnProfile.json @@ -5,8 +5,8 @@ "resourceGroupName": "rg1", "gatewayName" : "p2sVpnGateway1", "parameters": { - "authenticationMethod": "EAPTLS" - } + "authenticationMethod": "EAPTLS" + } }, "responses" : { "202" : { diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/P2SVpnGatewayGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/P2SVpnGatewayGet.json index d08893856018..285260318bac 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/P2SVpnGatewayGet.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/P2SVpnGatewayGet.json @@ -26,21 +26,21 @@ "101.3.0.0/16" ] }, - "customRoutes": { - "addressPrefixes": [ - "101.168.0.6/32" - ] - }, + "customRoutes": { + "addressPrefixes": [ + "101.168.0.6/32" + ] + }, "vpnGatewayScaleUnit": 1, - "vpnClientConnectionHealth": { - "vpnClientConnectionsCount": 2, - "allocatedIpAddresses": [ - "1.1.1.1", - "2.2.2.2" - ], - "totalIngressBytesTransferred":2000, - "totalEgressBytesTransferred":3000 - } + "vpnClientConnectionHealth": { + "vpnClientConnectionsCount": 2, + "allocatedIpAddresses": [ + "1.1.1.1", + "2.2.2.2" + ], + "totalIngressBytesTransferred":2000, + "totalEgressBytesTransferred":3000 + } } } } diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/P2SVpnGatewayList.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/P2SVpnGatewayList.json index 4602602a7670..1ddbb74beeb5 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/P2SVpnGatewayList.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/P2SVpnGatewayList.json @@ -27,21 +27,21 @@ "101.3.0.0/16" ] }, - "customRoutes": { - "addressPrefixes": [ - "101.168.0.6/32" - ] - }, + "customRoutes": { + "addressPrefixes": [ + "101.168.0.6/32" + ] + }, "vpnGatewayScaleUnit": 1, - "vpnClientConnectionHealth": { - "vpnClientConnectionsCount": 2, - "allocatedIpAddresses": [ - "1.1.1.1", - "2.2.2.2" - ], - "totalIngressBytesTransferred":2000, - "totalEgressBytesTransferred":3000 - } + "vpnClientConnectionHealth": { + "vpnClientConnectionsCount": 2, + "allocatedIpAddresses": [ + "1.1.1.1", + "2.2.2.2" + ], + "totalIngressBytesTransferred":2000, + "totalEgressBytesTransferred":3000 + } } }, { @@ -63,21 +63,21 @@ "101.4.0.0/16" ] }, - "customRoutes": { - "addressPrefixes": [ - "101.168.0.6/32" - ] - }, + "customRoutes": { + "addressPrefixes": [ + "101.168.0.6/32" + ] + }, "vpnGatewayScaleUnit": 1, - "vpnClientConnectionHealth": { - "vpnClientConnectionsCount": 2, - "allocatedIpAddresses": [ - "1.1.1.1", - "2.2.2.2" - ], - "totalIngressBytesTransferred":2000, - "totalEgressBytesTransferred":3000 - } + "vpnClientConnectionHealth": { + "vpnClientConnectionsCount": 2, + "allocatedIpAddresses": [ + "1.1.1.1", + "2.2.2.2" + ], + "totalIngressBytesTransferred":2000, + "totalEgressBytesTransferred":3000 + } } } ] diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/P2SVpnGatewayListByResourceGroup.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/P2SVpnGatewayListByResourceGroup.json index 4602602a7670..1ddbb74beeb5 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/P2SVpnGatewayListByResourceGroup.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/P2SVpnGatewayListByResourceGroup.json @@ -27,21 +27,21 @@ "101.3.0.0/16" ] }, - "customRoutes": { - "addressPrefixes": [ - "101.168.0.6/32" - ] - }, + "customRoutes": { + "addressPrefixes": [ + "101.168.0.6/32" + ] + }, "vpnGatewayScaleUnit": 1, - "vpnClientConnectionHealth": { - "vpnClientConnectionsCount": 2, - "allocatedIpAddresses": [ - "1.1.1.1", - "2.2.2.2" - ], - "totalIngressBytesTransferred":2000, - "totalEgressBytesTransferred":3000 - } + "vpnClientConnectionHealth": { + "vpnClientConnectionsCount": 2, + "allocatedIpAddresses": [ + "1.1.1.1", + "2.2.2.2" + ], + "totalIngressBytesTransferred":2000, + "totalEgressBytesTransferred":3000 + } } }, { @@ -63,21 +63,21 @@ "101.4.0.0/16" ] }, - "customRoutes": { - "addressPrefixes": [ - "101.168.0.6/32" - ] - }, + "customRoutes": { + "addressPrefixes": [ + "101.168.0.6/32" + ] + }, "vpnGatewayScaleUnit": 1, - "vpnClientConnectionHealth": { - "vpnClientConnectionsCount": 2, - "allocatedIpAddresses": [ - "1.1.1.1", - "2.2.2.2" - ], - "totalIngressBytesTransferred":2000, - "totalEgressBytesTransferred":3000 - } + "vpnClientConnectionHealth": { + "vpnClientConnectionsCount": 2, + "allocatedIpAddresses": [ + "1.1.1.1", + "2.2.2.2" + ], + "totalIngressBytesTransferred":2000, + "totalEgressBytesTransferred":3000 + } } } ] diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/P2SVpnGatewayPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/P2SVpnGatewayPut.json index 3e651ce38a06..b6c0d8b6e2ac 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/P2SVpnGatewayPut.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/P2SVpnGatewayPut.json @@ -21,12 +21,12 @@ "101.3.0.0/16" ] }, - "customRoutes": { - "addressPrefixes": [ - "101.168.0.6/32" - ] - }, - "vpnGatewayScaleUnit": 1 + "customRoutes": { + "addressPrefixes": [ + "101.168.0.6/32" + ] + }, + "vpnGatewayScaleUnit": 1 } } }, @@ -50,18 +50,18 @@ "101.3.0.0/16" ] }, - "customRoutes": { - "addressPrefixes": [ - "101.168.0.6/32" - ] - }, + "customRoutes": { + "addressPrefixes": [ + "101.168.0.6/32" + ] + }, "vpnGatewayScaleUnit": 1, - "vpnClientConnectionHealth": { - "vpnClientConnectionsCount": 0, - "allocatedIpAddresses": [], - "totalIngressBytesTransferred": 0, - "totalEgressBytesTransferred": 0 - } + "vpnClientConnectionHealth": { + "vpnClientConnectionsCount": 0, + "allocatedIpAddresses": [], + "totalIngressBytesTransferred": 0, + "totalEgressBytesTransferred": 0 + } } }, "201": { @@ -83,18 +83,18 @@ "101.3.0.0/16" ] }, - "customRoutes": { - "addressPrefixes": [ - "101.168.0.6/32" - ] - }, + "customRoutes": { + "addressPrefixes": [ + "101.168.0.6/32" + ] + }, "vpnGatewayScaleUnit": 1, - "vpnClientConnectionHealth": { - "vpnClientConnectionsCount": 0, - "allocatedIpAddresses": [], - "totalIngressBytesTransferred": 0, - "totalEgressBytesTransferred": 0 - } + "vpnClientConnectionHealth": { + "vpnClientConnectionsCount": 0, + "allocatedIpAddresses": [], + "totalIngressBytesTransferred": 0, + "totalEgressBytesTransferred": 0 + } } } } diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/P2SVpnGatewayUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/P2SVpnGatewayUpdateTags.json index 25621e1b7f35..f642c3821d75 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/P2SVpnGatewayUpdateTags.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/P2SVpnGatewayUpdateTags.json @@ -35,21 +35,21 @@ "101.3.0.0/16" ] }, - "customRoutes": { - "addressPrefixes": [ - "101.168.0.6/32" - ] - }, + "customRoutes": { + "addressPrefixes": [ + "101.168.0.6/32" + ] + }, "vpnGatewayScaleUnit": 1, - "vpnClientConnectionHealth": { - "vpnClientConnectionsCount": 2, - "allocatedIpAddresses": [ - "1.1.1.1", - "2.2.2.2" - ], - "totalIngressBytesTransferred":2000, - "totalEgressBytesTransferred":3000 - } + "vpnClientConnectionHealth": { + "vpnClientConnectionsCount": 2, + "allocatedIpAddresses": [ + "1.1.1.1", + "2.2.2.2" + ], + "totalIngressBytesTransferred":2000, + "totalEgressBytesTransferred":3000 + } } }, "201": { @@ -75,21 +75,21 @@ "101.3.0.0/16" ] }, - "customRoutes": { - "addressPrefixes": [ - "101.168.0.6/32" - ] - }, + "customRoutes": { + "addressPrefixes": [ + "101.168.0.6/32" + ] + }, "vpnGatewayScaleUnit": 1, - "vpnClientConnectionHealth": { - "vpnClientConnectionsCount": 2, - "allocatedIpAddresses": [ - "1.1.1.1", - "2.2.2.2" - ], - "totalIngressBytesTransferred":2000, - "totalEgressBytesTransferred":3000 - } + "vpnClientConnectionHealth": { + "vpnClientConnectionsCount": 2, + "allocatedIpAddresses": [ + "1.1.1.1", + "2.2.2.2" + ], + "totalIngressBytesTransferred":2000, + "totalEgressBytesTransferred":3000 + } } } } diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/P2SVpnServerConfigurationGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/P2SVpnServerConfigurationGet.json index a1f7089c0421..e58e97b3837b 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/P2SVpnServerConfigurationGet.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/P2SVpnServerConfigurationGet.json @@ -16,7 +16,7 @@ "vpnProtocols": [ "IkeV2" ], - "vpnClientIpsecPolicies": [{ + "vpnClientIpsecPolicies": [{ "saLifeTimeSeconds": 86472, "saDataSizeKilobytes": 429497, "ipsecEncryption": "AES256", @@ -28,48 +28,48 @@ }], "p2SVpnServerConfigVpnClientRootCertificates": [{ "name": "p2sVpnServerConfigVpnClientRootCert1", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1/p2sVpnServerConfigurations/p2sVpnServerConfiguration1/p2sVpnServerConfigVpnClientRootCertificates/p2sVpnServerConfigVpnClientRootCert1", - "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1/p2sVpnServerConfigurations/p2sVpnServerConfiguration1/p2sVpnServerConfigVpnClientRootCertificates/p2sVpnServerConfigVpnClientRootCert1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", "properties": { - "provisioningState": "Succeeded", + "provisioningState": "Succeeded", "publicCertData": "MIIC5zCCAc+gAwIBAgIQErQ0Hk4aDJxIA+Q5RagB+jANBgkqhkiG9w0BAQsFADAWMRQwEgYDVQQDDAtQMlNSb290Q2VydDAeFw0xNzEyMTQyMTA3MzhaFw0xODEyMTQyMTI3MzhaMBYxFDASBgNVBAMMC1AyU1Jvb3RDZXJ0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEArP7/NQXmW7cQ/ZR1mv3Y3I29Lt7HTOqzo/1KUOoVH3NItbQIRAQbwKy3UWrOFz4eGNX2GWtNRMdCyWsKeqy9Ltsdfcm1IbKXkl84DFeU/ZacXu4Dl3xX3gV5du4TLZjEowJELyur11Ea2YcjPRQ/FzAF9/hGuboS1HZQEPLx4FdUs9OxCYOtc0MxBCwLfVTTRqarb0Ne+arNYd4kCzIhAke1nOyKAJBda5ZL+VHy3S5S8qGlD46jm8HXugmAkUygS4oIIXOmj/1O9sNAi3LN60zufSzCmP8Rm/iUGX+DHAGGiXxwZOKQLEDaZXKqoHjMPP0XudmSWwOIbyeQVrLhkwIDAQABozEwLzAOBgNVHQ8BAf8EBAMCAgQwHQYDVR0OBBYEFEfeNU2trYxNLF9ONmuJUsT13pKDMA0GCSqGSIb3DQEBCwUAA4IBAQBmM6RJzsGGipxyMhimHKN2xlkejhVsgBoTAhOU0llW9aUSwINJ9zFUGgI8IzUFy1VG776fchHp0LMRmPSIUYk5btEPxbsrPtumPuMH8EQGrS+Rt4pD+78c8H1fEPkq5CmDl/PKu4JoFGv+aFcE+Od0hlILstIF10Qysf++QXDolKfzJa/56bgMeYKFiju73loiRM57ns8ddXpfLl792UVpRkFU62LNns6Y1LKTwapmUF4IvIuAIzd6LZNOQng64LAKXtKnViJ1JQiXwf4CEzhgvAti3/ejpb3U90hsrUcyZi6wBv9bZLcAJRWpz61JNYliM1d1grSwQDKGXNQE4xuN" }, - "type": "Microsoft.Network/virtualWans/p2sVpnServerConfigurations/p2sVpnServerConfigVpnClientRootCertificates" + "type": "Microsoft.Network/virtualWans/p2sVpnServerConfigurations/p2sVpnServerConfigVpnClientRootCertificates" }], - "p2SVpnServerConfigVpnClientRevokedCertificates": [{ - "name": "p2sVpnServerConfigVpnClientRevokedCert1", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1/p2sVpnServerConfigurations/p2sVpnServerConfiguration1/p2sVpnServerConfigVpnClientRevokedCertificates/p2sVpnServerConfigVpnClientRevokedCert1", - "etag": "w/\\00000000-0000-0000-0000-000000000000\\", - "properties": { - "provisioningState": "Succeeded", - "Thumbprint": "83FFBFC8848B5A5836C94D0112367E16148A286F" - }, - "type": "Microsoft.Network/virtualWans/p2sVpnServerConfigurations/p2sVpnServerConfigVpnClientRevokedCertificates" - }], - "radiusServerAddress": "8.9.9.9", - "radiusServerSecret":"123_abc", - "p2SVpnServerConfigRadiusServerRootCertificates": [{ + "p2SVpnServerConfigVpnClientRevokedCertificates": [{ + "name": "p2sVpnServerConfigVpnClientRevokedCert1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1/p2sVpnServerConfigurations/p2sVpnServerConfiguration1/p2sVpnServerConfigVpnClientRevokedCertificates/p2sVpnServerConfigVpnClientRevokedCert1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "Thumbprint": "83FFBFC8848B5A5836C94D0112367E16148A286F" + }, + "type": "Microsoft.Network/virtualWans/p2sVpnServerConfigurations/p2sVpnServerConfigVpnClientRevokedCertificates" + }], + "radiusServerAddress": "8.9.9.9", + "radiusServerSecret":"123_abc", + "p2SVpnServerConfigRadiusServerRootCertificates": [{ "name": "p2sVpnServerConfigRadiusServerRootCer1", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1/p2sVpnServerConfigurations/p2sVpnServerConfiguration1/p2sVpnServerConfigRadiusServerRootCertificates/p2sVpnServerConfigRadiusServerRootCer1", - "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1/p2sVpnServerConfigurations/p2sVpnServerConfiguration1/p2sVpnServerConfigRadiusServerRootCertificates/p2sVpnServerConfigRadiusServerRootCer1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", "properties": { - "provisioningState": "Succeeded", + "provisioningState": "Succeeded", "publicCertData": "MIIC5zCCAc+gAwIBAgIQErQ0Hk4aDJxIA+Q5RagB+jANBgkqhkiG9w0BAQsFADAWMRQwEgYDVQQDDAtQMlNSb290Q2VydDAeFw0xNzEyMTQyMTA3MzhaFw0xODEyMTQyMTI3MzhaMBYxFDASBgNVBAMMC1AyU1Jvb3RDZXJ0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEArP7/NQXmW7cQ/ZR1mv3Y3I29Lt7HTOqzo/1KUOoVH3NItbQIRAQbwKy3UWrOFz4eGNX2GWtNRMdCyWsKeqy9Ltsdfcm1IbKXkl84DFeU/ZacXu4Dl3xX3gV5du4TLZjEowJELyur11Ea2YcjPRQ/FzAF9/hGuboS1HZQEPLx4FdUs9OxCYOtc0MxBCwLfVTTRqarb0Ne+arNYd4kCzIhAke1nOyKAJBda5ZL+VHy3S5S8qGlD46jm8HXugmAkUygS4oIIXOmj/1O9sNAi3LN60zufSzCmP8Rm/iUGX+DHAGGiXxwZOKQLEDaZXKqoHjMPP0XudmSWwOIbyeQVrLhkwIDAQABozEwLzAOBgNVHQ8BAf8EBAMCAgQwHQYDVR0OBBYEFEfeNU2trYxNLF9ONmuJUsT13pKDMA0GCSqGSIb3DQEBCwUAA4IBAQBmM6RJzsGGipxyMhimHKN2xlkejhVsgBoTAhOU0llW9aUSwINJ9zFUGgI8IzUFy1VG776fchHp0LMRmPSIUYk5btEPxbsrPtumPuMH8EQGrS+Rt4pD+78c8H1fEPkq5CmDl/PKu4JoFGv+aFcE+Od0hlILstIF10Qysf++QXDolKfzJa/56bgMeYKFiju73loiRM57ns8ddXpfLl792UVpRkFU62LNns6Y1LKTwapmUF4IvIuAIzd6LZNOQng64LAKXtKnViJ1JQiXwf4CEzhgvAti3/ejpb3U90hsrUcyZi6wBv9bZLcAJRWpz61JNYliM1d1grSwQDKGXNQE4xuM" }, - "type": "Microsoft.Network/virtualWans/p2sVpnServerConfigurations/p2sVpnServerConfigRadiusServerRootCertificates" + "type": "Microsoft.Network/virtualWans/p2sVpnServerConfigurations/p2sVpnServerConfigRadiusServerRootCertificates" }], - "p2SVpnServerConfigRadiusClientRootCertificates": [{ - "name": "p2sVpnServerConfigRadiusClientRootCert1", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1/p2sVpnServerConfigurations/p2sVpnServerConfiguration1/p2sVpnServerConfigRadiusClientRootCertificates/p2sVpnServerConfigRadiusClientRootCert1", - "etag": "w/\\00000000-0000-0000-0000-000000000000\\", - "properties": { - "provisioningState": "Succeeded", - "Thumbprint": "83FFBFC8848B5A5836C94D0112367E16148A286F" - }, - "type": "Microsoft.Network/virtualWans/p2sVpnServerConfigurations/p2sVpnServerConfigRadiusClientRootCertificates" - }] + "p2SVpnServerConfigRadiusClientRootCertificates": [{ + "name": "p2sVpnServerConfigRadiusClientRootCert1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1/p2sVpnServerConfigurations/p2sVpnServerConfiguration1/p2sVpnServerConfigRadiusClientRootCertificates/p2sVpnServerConfigRadiusClientRootCert1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "Thumbprint": "83FFBFC8848B5A5836C94D0112367E16148A286F" + }, + "type": "Microsoft.Network/virtualWans/p2sVpnServerConfigurations/p2sVpnServerConfigRadiusClientRootCertificates" + }] }, - "type": "Microsoft.Network/virtualWans/p2sVpnServerConfigurations" + "type": "Microsoft.Network/virtualWans/p2sVpnServerConfigurations" } } } diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/P2SVpnServerConfigurationList.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/P2SVpnServerConfigurationList.json index 17983a59f9de..0d1c441cb528 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/P2SVpnServerConfigurationList.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/P2SVpnServerConfigurationList.json @@ -1,6 +1,6 @@ { - "parameters": { - "virtualWanName": "virtualWan1", + "parameters": { + "virtualWanName": "virtualWan1", "api-version": "2019-04-01", "resourceGroupName": "rg1", "subscriptionId": "subid" @@ -17,7 +17,7 @@ "vpnProtocols": [ "IkeV2" ], - "vpnClientIpsecPolicies": [{ + "vpnClientIpsecPolicies": [{ "saLifeTimeSeconds": 86472, "saDataSizeKilobytes": 429497, "ipsecEncryption": "AES256", @@ -29,46 +29,46 @@ }], "p2SVpnServerConfigVpnClientRootCertificates": [{ "name": "p2sVpnServerConfigVpnClientRootCert1", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1/p2sVpnServerConfigurations/p2sVpnServerConfiguration1/p2sVpnServerConfigVpnClientRootCertificates/p2sVpnServerConfigVpnClientRootCert1", - "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1/p2sVpnServerConfigurations/p2sVpnServerConfiguration1/p2sVpnServerConfigVpnClientRootCertificates/p2sVpnServerConfigVpnClientRootCert1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", "properties": { - "provisioningState": "Succeeded", + "provisioningState": "Succeeded", "publicCertData": "MIIC5zCCAc+gAwIBAgIQErQ0Hk4aDJxIA+Q5RagB+jANBgkqhkiG9w0BAQsFADAWMRQwEgYDVQQDDAtQMlNSb290Q2VydDAeFw0xNzEyMTQyMTA3MzhaFw0xODEyMTQyMTI3MzhaMBYxFDASBgNVBAMMC1AyU1Jvb3RDZXJ0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEArP7/NQXmW7cQ/ZR1mv3Y3I29Lt7HTOqzo/1KUOoVH3NItbQIRAQbwKy3UWrOFz4eGNX2GWtNRMdCyWsKeqy9Ltsdfcm1IbKXkl84DFeU/ZacXu4Dl3xX3gV5du4TLZjEowJELyur11Ea2YcjPRQ/FzAF9/hGuboS1HZQEPLx4FdUs9OxCYOtc0MxBCwLfVTTRqarb0Ne+arNYd4kCzIhAke1nOyKAJBda5ZL+VHy3S5S8qGlD46jm8HXugmAkUygS4oIIXOmj/1O9sNAi3LN60zufSzCmP8Rm/iUGX+DHAGGiXxwZOKQLEDaZXKqoHjMPP0XudmSWwOIbyeQVrLhkwIDAQABozEwLzAOBgNVHQ8BAf8EBAMCAgQwHQYDVR0OBBYEFEfeNU2trYxNLF9ONmuJUsT13pKDMA0GCSqGSIb3DQEBCwUAA4IBAQBmM6RJzsGGipxyMhimHKN2xlkejhVsgBoTAhOU0llW9aUSwINJ9zFUGgI8IzUFy1VG776fchHp0LMRmPSIUYk5btEPxbsrPtumPuMH8EQGrS+Rt4pD+78c8H1fEPkq5CmDl/PKu4JoFGv+aFcE+Od0hlILstIF10Qysf++QXDolKfzJa/56bgMeYKFiju73loiRM57ns8ddXpfLl792UVpRkFU62LNns6Y1LKTwapmUF4IvIuAIzd6LZNOQng64LAKXtKnViJ1JQiXwf4CEzhgvAti3/ejpb3U90hsrUcyZi6wBv9bZLcAJRWpz61JNYliM1d1grSwQDKGXNQE4xuN" }, - "type": "Microsoft.Network/virtualWans/p2sVpnServerConfigurations/p2sVpnServerConfigVpnClientRootCertificates" + "type": "Microsoft.Network/virtualWans/p2sVpnServerConfigurations/p2sVpnServerConfigVpnClientRootCertificates" }], - "p2SVpnServerConfigVpnClientRevokedCertificates": [{ - "name": "p2sVpnServerConfigVpnClientRevokedCert1", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1/p2sVpnServerConfigurations/p2sVpnServerConfiguration1/p2sVpnServerConfigVpnClientRevokedCertificates/VpnClientRevokedCert2", - "etag": "w/\\00000000-0000-0000-0000-000000000000\\", - "properties": { - "provisioningState": "Succeeded", - "Thumbprint": "83FFBFC8848B5A5836C94D0112367E16148A286F" - }, - "type": "Microsoft.Network/virtualWans/p2sVpnServerConfigurations/p2sVpnServerConfigVpnClientRevokedCertificates" - }], - "radiusServerAddress": "8.9.9.9", - "radiusServerSecret":"123_abc", - "p2SVpnServerConfigRadiusServerRootCertificates": [{ + "p2SVpnServerConfigVpnClientRevokedCertificates": [{ + "name": "p2sVpnServerConfigVpnClientRevokedCert1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1/p2sVpnServerConfigurations/p2sVpnServerConfiguration1/p2sVpnServerConfigVpnClientRevokedCertificates/VpnClientRevokedCert2", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "Thumbprint": "83FFBFC8848B5A5836C94D0112367E16148A286F" + }, + "type": "Microsoft.Network/virtualWans/p2sVpnServerConfigurations/p2sVpnServerConfigVpnClientRevokedCertificates" + }], + "radiusServerAddress": "8.9.9.9", + "radiusServerSecret":"123_abc", + "p2SVpnServerConfigRadiusServerRootCertificates": [{ "name": "p2sVpnServerConfigRadiusServerRootCert1", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1/p2sVpnServerConfigurations/p2sVpnServerConfiguration1/p2sVpnServerConfigRadiusServerRootCertificates/p2sVpnServerConfigRadiusServerRootCert", - "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1/p2sVpnServerConfigurations/p2sVpnServerConfiguration1/p2sVpnServerConfigRadiusServerRootCertificates/p2sVpnServerConfigRadiusServerRootCert", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", "properties": { - "provisioningState": "Succeeded", + "provisioningState": "Succeeded", "publicCertData": "MIIC5zCCAc+gAwIBAgIQErQ0Hk4aDJxIA+Q5RagB+jANBgkqhkiG9w0BAQsFADAWMRQwEgYDVQQDDAtQMlNSb290Q2VydDAeFw0xNzEyMTQyMTA3MzhaFw0xODEyMTQyMTI3MzhaMBYxFDASBgNVBAMMC1AyU1Jvb3RDZXJ0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEArP7/NQXmW7cQ/ZR1mv3Y3I29Lt7HTOqzo/1KUOoVH3NItbQIRAQbwKy3UWrOFz4eGNX2GWtNRMdCyWsKeqy9Ltsdfcm1IbKXkl84DFeU/ZacXu4Dl3xX3gV5du4TLZjEowJELyur11Ea2YcjPRQ/FzAF9/hGuboS1HZQEPLx4FdUs9OxCYOtc0MxBCwLfVTTRqarb0Ne+arNYd4kCzIhAke1nOyKAJBda5ZL+VHy3S5S8qGlD46jm8HXugmAkUygS4oIIXOmj/1O9sNAi3LN60zufSzCmP8Rm/iUGX+DHAGGiXxwZOKQLEDaZXKqoHjMPP0XudmSWwOIbyeQVrLhkwIDAQABozEwLzAOBgNVHQ8BAf8EBAMCAgQwHQYDVR0OBBYEFEfeNU2trYxNLF9ONmuJUsT13pKDMA0GCSqGSIb3DQEBCwUAA4IBAQBmM6RJzsGGipxyMhimHKN2xlkejhVsgBoTAhOU0llW9aUSwINJ9zFUGgI8IzUFy1VG776fchHp0LMRmPSIUYk5btEPxbsrPtumPuMH8EQGrS+Rt4pD+78c8H1fEPkq5CmDl/PKu4JoFGv+aFcE+Od0hlILstIF10Qysf++QXDolKfzJa/56bgMeYKFiju73loiRM57ns8ddXpfLl792UVpRkFU62LNns6Y1LKTwapmUF4IvIuAIzd6LZNOQng64LAKXtKnViJ1JQiXwf4CEzhgvAti3/ejpb3U90hsrUcyZi6wBv9bZLcAJRWpz61JNYliM1d1grSwQDKGXNQE4xuM" }, - "type": "Microsoft.Network/virtualWans/p2sVpnServerConfigurations/p2sVpnServerConfigRadiusServerRootCertificates" + "type": "Microsoft.Network/virtualWans/p2sVpnServerConfigurations/p2sVpnServerConfigRadiusServerRootCertificates" }], - "p2SVpnServerConfigRadiusClientRootCertificates": [{ - "name": "p2sVpnServerConfigRadiusClientRootCert1", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1/p2sVpnServerConfigurations/p2sVpnServerConfiguration1/p2sVpnServerConfigRadiusClientRootCertificates/p2sVpnServerConfigRadiusClientRootCert1", - "etag": "w/\\00000000-0000-0000-0000-000000000000\\", - "properties": { - "provisioningState": "Succeeded", - "Thumbprint": "83FFBFC8848B5A5836C94D0112367E16148A286F" - }, - "type": "Microsoft.Network/virtualWans/p2sVpnServerConfigurations/p2sVpnServerConfigRadiusClientRootCertificates" - }] + "p2SVpnServerConfigRadiusClientRootCertificates": [{ + "name": "p2sVpnServerConfigRadiusClientRootCert1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1/p2sVpnServerConfigurations/p2sVpnServerConfiguration1/p2sVpnServerConfigRadiusClientRootCertificates/p2sVpnServerConfigRadiusClientRootCert1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "Thumbprint": "83FFBFC8848B5A5836C94D0112367E16148A286F" + }, + "type": "Microsoft.Network/virtualWans/p2sVpnServerConfigurations/p2sVpnServerConfigRadiusClientRootCertificates" + }] } } ] diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/P2SVpnServerConfigurationPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/P2SVpnServerConfigurationPut.json index 436f4fcd86d9..5c7540814384 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/P2SVpnServerConfigurationPut.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/P2SVpnServerConfigurationPut.json @@ -10,7 +10,7 @@ "vpnProtocols": [ "IkeV2" ], - "vpnClientIpsecPolicies": [{ + "vpnClientIpsecPolicies": [{ "saLifeTimeSeconds": 86472, "saDataSizeKilobytes": 429497, "ipsecEncryption": "AES256", @@ -26,26 +26,26 @@ "publicCertData": "MIIC5zCCAc+gAwIBAgIQErQ0Hk4aDJxIA+Q5RagB+jANBgkqhkiG9w0BAQsFADAWMRQwEgYDVQQDDAtQMlNSb290Q2VydDAeFw0xNzEyMTQyMTA3MzhaFw0xODEyMTQyMTI3MzhaMBYxFDASBgNVBAMMC1AyU1Jvb3RDZXJ0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEArP7/NQXmW7cQ/ZR1mv3Y3I29Lt7HTOqzo/1KUOoVH3NItbQIRAQbwKy3UWrOFz4eGNX2GWtNRMdCyWsKeqy9Ltsdfcm1IbKXkl84DFeU/ZacXu4Dl3xX3gV5du4TLZjEowJELyur11Ea2YcjPRQ/FzAF9/hGuboS1HZQEPLx4FdUs9OxCYOtc0MxBCwLfVTTRqarb0Ne+arNYd4kCzIhAke1nOyKAJBda5ZL+VHy3S5S8qGlD46jm8HXugmAkUygS4oIIXOmj/1O9sNAi3LN60zufSzCmP8Rm/iUGX+DHAGGiXxwZOKQLEDaZXKqoHjMPP0XudmSWwOIbyeQVrLhkwIDAQABozEwLzAOBgNVHQ8BAf8EBAMCAgQwHQYDVR0OBBYEFEfeNU2trYxNLF9ONmuJUsT13pKDMA0GCSqGSIb3DQEBCwUAA4IBAQBmM6RJzsGGipxyMhimHKN2xlkejhVsgBoTAhOU0llW9aUSwINJ9zFUGgI8IzUFy1VG776fchHp0LMRmPSIUYk5btEPxbsrPtumPuMH8EQGrS+Rt4pD+78c8H1fEPkq5CmDl/PKu4JoFGv+aFcE+Od0hlILstIF10Qysf++QXDolKfzJa/56bgMeYKFiju73loiRM57ns8ddXpfLl792UVpRkFU62LNns6Y1LKTwapmUF4IvIuAIzd6LZNOQng64LAKXtKnViJ1JQiXwf4CEzhgvAti3/ejpb3U90hsrUcyZi6wBv9bZLcAJRWpz61JNYliM1d1grSwQDKGXNQE4xuN" } }], - "p2SVpnServerConfigVpnClientRevokedCertificates": [{ - "name": "p2sVpnServerConfigVpnClientRevokedCert1", - "properties": { - "thumbprint": "83FFBFC8848B5A5836C94D0112367E16148A286F" - } - }], - "radiusServerAddress": "8.9.9.9", - "radiusServerSecret":"123_abc", - "p2SVpnServerConfigRadiusServerRootCertificates": [{ + "p2SVpnServerConfigVpnClientRevokedCertificates": [{ + "name": "p2sVpnServerConfigVpnClientRevokedCert1", + "properties": { + "thumbprint": "83FFBFC8848B5A5836C94D0112367E16148A286F" + } + }], + "radiusServerAddress": "8.9.9.9", + "radiusServerSecret":"123_abc", + "p2SVpnServerConfigRadiusServerRootCertificates": [{ "name": "p2sVpnServerConfigRadiusServerRootCert1", "properties": { "publicCertData": "MIIC5zCCAc+gAwIBAgIQErQ0Hk4aDJxIA+Q5RagB+jANBgkqhkiG9w0BAQsFADAWMRQwEgYDVQQDDAtQMlNSb290Q2VydDAeFw0xNzEyMTQyMTA3MzhaFw0xODEyMTQyMTI3MzhaMBYxFDASBgNVBAMMC1AyU1Jvb3RDZXJ0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEArP7/NQXmW7cQ/ZR1mv3Y3I29Lt7HTOqzo/1KUOoVH3NItbQIRAQbwKy3UWrOFz4eGNX2GWtNRMdCyWsKeqy9Ltsdfcm1IbKXkl84DFeU/ZacXu4Dl3xX3gV5du4TLZjEowJELyur11Ea2YcjPRQ/FzAF9/hGuboS1HZQEPLx4FdUs9OxCYOtc0MxBCwLfVTTRqarb0Ne+arNYd4kCzIhAke1nOyKAJBda5ZL+VHy3S5S8qGlD46jm8HXugmAkUygS4oIIXOmj/1O9sNAi3LN60zufSzCmP8Rm/iUGX+DHAGGiXxwZOKQLEDaZXKqoHjMPP0XudmSWwOIbyeQVrLhkwIDAQABozEwLzAOBgNVHQ8BAf8EBAMCAgQwHQYDVR0OBBYEFEfeNU2trYxNLF9ONmuJUsT13pKDMA0GCSqGSIb3DQEBCwUAA4IBAQBmM6RJzsGGipxyMhimHKN2xlkejhVsgBoTAhOU0llW9aUSwINJ9zFUGgI8IzUFy1VG776fchHp0LMRmPSIUYk5btEPxbsrPtumPuMH8EQGrS+Rt4pD+78c8H1fEPkq5CmDl/PKu4JoFGv+aFcE+Od0hlILstIF10Qysf++QXDolKfzJa/56bgMeYKFiju73loiRM57ns8ddXpfLl792UVpRkFU62LNns6Y1LKTwapmUF4IvIuAIzd6LZNOQng64LAKXtKnViJ1JQiXwf4CEzhgvAti3/ejpb3U90hsrUcyZi6wBv9bZLcAJRWpz61JNYliM1d1grSwQDKGXNQE4xuM" } }], - "p2SVpnServerConfigRadiusClientRootCertificates": [{ - "name": "p2sVpnServerConfigRadiusClientRootCert1", - "properties": { - "thumbprint": "83FFBFC8848B5A5836C94D0112367E16148A286F" - } - }] + "p2SVpnServerConfigRadiusClientRootCertificates": [{ + "name": "p2sVpnServerConfigRadiusClientRootCert1", + "properties": { + "thumbprint": "83FFBFC8848B5A5836C94D0112367E16148A286F" + } + }] } } }, @@ -59,7 +59,7 @@ "vpnProtocols": [ "IkeV2" ], - "vpnClientIpsecPolicies": [{ + "vpnClientIpsecPolicies": [{ "saLifeTimeSeconds": 86472, "saDataSizeKilobytes": 429497, "ipsecEncryption": "AES256", @@ -71,48 +71,48 @@ }], "p2SVpnServerConfigVpnClientRootCertificates": [{ "name": "p2sVpnServerConfigVpnClientRootCert1", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1/p2sVpnServerConfigurations/p2sVpnServerConfiguration1/p2sVpnServerConfigVpnClientRootCertificates/p2sVpnServerConfigVpnClientRootCert1", - "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1/p2sVpnServerConfigurations/p2sVpnServerConfiguration1/p2sVpnServerConfigVpnClientRootCertificates/p2sVpnServerConfigVpnClientRootCert1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", "properties": { - "provisioningState": "Succeeded", + "provisioningState": "Succeeded", "publicCertData": "MIIC5zCCAc+gAwIBAgIQErQ0Hk4aDJxIA+Q5RagB+jANBgkqhkiG9w0BAQsFADAWMRQwEgYDVQQDDAtQMlNSb290Q2VydDAeFw0xNzEyMTQyMTA3MzhaFw0xODEyMTQyMTI3MzhaMBYxFDASBgNVBAMMC1AyU1Jvb3RDZXJ0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEArP7/NQXmW7cQ/ZR1mv3Y3I29Lt7HTOqzo/1KUOoVH3NItbQIRAQbwKy3UWrOFz4eGNX2GWtNRMdCyWsKeqy9Ltsdfcm1IbKXkl84DFeU/ZacXu4Dl3xX3gV5du4TLZjEowJELyur11Ea2YcjPRQ/FzAF9/hGuboS1HZQEPLx4FdUs9OxCYOtc0MxBCwLfVTTRqarb0Ne+arNYd4kCzIhAke1nOyKAJBda5ZL+VHy3S5S8qGlD46jm8HXugmAkUygS4oIIXOmj/1O9sNAi3LN60zufSzCmP8Rm/iUGX+DHAGGiXxwZOKQLEDaZXKqoHjMPP0XudmSWwOIbyeQVrLhkwIDAQABozEwLzAOBgNVHQ8BAf8EBAMCAgQwHQYDVR0OBBYEFEfeNU2trYxNLF9ONmuJUsT13pKDMA0GCSqGSIb3DQEBCwUAA4IBAQBmM6RJzsGGipxyMhimHKN2xlkejhVsgBoTAhOU0llW9aUSwINJ9zFUGgI8IzUFy1VG776fchHp0LMRmPSIUYk5btEPxbsrPtumPuMH8EQGrS+Rt4pD+78c8H1fEPkq5CmDl/PKu4JoFGv+aFcE+Od0hlILstIF10Qysf++QXDolKfzJa/56bgMeYKFiju73loiRM57ns8ddXpfLl792UVpRkFU62LNns6Y1LKTwapmUF4IvIuAIzd6LZNOQng64LAKXtKnViJ1JQiXwf4CEzhgvAti3/ejpb3U90hsrUcyZi6wBv9bZLcAJRWpz61JNYliM1d1grSwQDKGXNQE4xuN" }, - "type": "Microsoft.Network/virtualWans/p2sVpnServerConfigurations/p2sVpnServerConfigVpnClientRootCertificates" + "type": "Microsoft.Network/virtualWans/p2sVpnServerConfigurations/p2sVpnServerConfigVpnClientRootCertificates" + }], + "p2SVpnServerConfigVpnClientRevokedCertificates": [{ + "name": "p2sVpnServerConfigVpnClientRevokedCert1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1/p2sVpnServerConfigurations/p2sVpnServerConfiguration1/p2sVpnServerConfigVpnClientRevokedCertificates/p2sVpnServerConfigVpnClientRevokedCert1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "Thumbprint": "83FFBFC8848B5A5836C94D0112367E16148A286F" + }, + "type": "Microsoft.Network/virtualWans/p2sVpnServerConfigurations/p2sVpnServerConfigVpnClientRevokedCertificates" }], - "p2SVpnServerConfigVpnClientRevokedCertificates": [{ - "name": "p2sVpnServerConfigVpnClientRevokedCert1", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1/p2sVpnServerConfigurations/p2sVpnServerConfiguration1/p2sVpnServerConfigVpnClientRevokedCertificates/p2sVpnServerConfigVpnClientRevokedCert1", - "etag": "w/\\00000000-0000-0000-0000-000000000000\\", - "properties": { - "provisioningState": "Succeeded", - "Thumbprint": "83FFBFC8848B5A5836C94D0112367E16148A286F" - }, - "type": "Microsoft.Network/virtualWans/p2sVpnServerConfigurations/p2sVpnServerConfigVpnClientRevokedCertificates" - }], - "radiusServerAddress": "8.9.9.9", - "radiusServerSecret":"123_abc", - "p2SVpnServerConfigRadiusServerRootCertificates": [{ + "radiusServerAddress": "8.9.9.9", + "radiusServerSecret":"123_abc", + "p2SVpnServerConfigRadiusServerRootCertificates": [{ "name": "p2sVpnServerConfigRadiusServerRootCert1", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1/p2sVpnServerConfigurations/p2sVpnServerConfiguration1/p2sVpnServerConfigRadiusServerRootCertificates/p2sVpnServerConfigRadiusServerRootCert1", - "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1/p2sVpnServerConfigurations/p2sVpnServerConfiguration1/p2sVpnServerConfigRadiusServerRootCertificates/p2sVpnServerConfigRadiusServerRootCert1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", "properties": { - "provisioningState": "Succeeded", + "provisioningState": "Succeeded", "publicCertData": "MIIC5zCCAc+gAwIBAgIQErQ0Hk4aDJxIA+Q5RagB+jANBgkqhkiG9w0BAQsFADAWMRQwEgYDVQQDDAtQMlNSb290Q2VydDAeFw0xNzEyMTQyMTA3MzhaFw0xODEyMTQyMTI3MzhaMBYxFDASBgNVBAMMC1AyU1Jvb3RDZXJ0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEArP7/NQXmW7cQ/ZR1mv3Y3I29Lt7HTOqzo/1KUOoVH3NItbQIRAQbwKy3UWrOFz4eGNX2GWtNRMdCyWsKeqy9Ltsdfcm1IbKXkl84DFeU/ZacXu4Dl3xX3gV5du4TLZjEowJELyur11Ea2YcjPRQ/FzAF9/hGuboS1HZQEPLx4FdUs9OxCYOtc0MxBCwLfVTTRqarb0Ne+arNYd4kCzIhAke1nOyKAJBda5ZL+VHy3S5S8qGlD46jm8HXugmAkUygS4oIIXOmj/1O9sNAi3LN60zufSzCmP8Rm/iUGX+DHAGGiXxwZOKQLEDaZXKqoHjMPP0XudmSWwOIbyeQVrLhkwIDAQABozEwLzAOBgNVHQ8BAf8EBAMCAgQwHQYDVR0OBBYEFEfeNU2trYxNLF9ONmuJUsT13pKDMA0GCSqGSIb3DQEBCwUAA4IBAQBmM6RJzsGGipxyMhimHKN2xlkejhVsgBoTAhOU0llW9aUSwINJ9zFUGgI8IzUFy1VG776fchHp0LMRmPSIUYk5btEPxbsrPtumPuMH8EQGrS+Rt4pD+78c8H1fEPkq5CmDl/PKu4JoFGv+aFcE+Od0hlILstIF10Qysf++QXDolKfzJa/56bgMeYKFiju73loiRM57ns8ddXpfLl792UVpRkFU62LNns6Y1LKTwapmUF4IvIuAIzd6LZNOQng64LAKXtKnViJ1JQiXwf4CEzhgvAti3/ejpb3U90hsrUcyZi6wBv9bZLcAJRWpz61JNYliM1d1grSwQDKGXNQE4xuM" }, - "type": "Microsoft.Network/virtualWans/p2sVpnServerConfigurations/p2sVpnServerConfigRadiusServerRootCertificates" + "type": "Microsoft.Network/virtualWans/p2sVpnServerConfigurations/p2sVpnServerConfigRadiusServerRootCertificates" }], - "p2SVpnServerConfigRadiusClientRootCertificates": [{ - "name": "p2sVpnServerConfigRadiusClientRootCert1", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1/p2sVpnServerConfigurations/p2sVpnServerConfiguration1/p2sVpnServerConfigRadiusClientRootCertificates/p2sVpnServerConfigRadiusClientRootCert1", - "etag": "w/\\00000000-0000-0000-0000-000000000000\\", - "properties": { - "provisioningState": "Succeeded", - "Thumbprint": "83FFBFC8848B5A5836C94D0112367E16148A286F" - }, - "type": "Microsoft.Network/virtualWans/p2sVpnServerConfigurations/p2sVpnServerConfigRadiusClientRootCertificates" - }] + "p2SVpnServerConfigRadiusClientRootCertificates": [{ + "name": "p2sVpnServerConfigRadiusClientRootCert1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1/p2sVpnServerConfigurations/p2sVpnServerConfiguration1/p2sVpnServerConfigRadiusClientRootCertificates/p2sVpnServerConfigRadiusClientRootCert1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "Thumbprint": "83FFBFC8848B5A5836C94D0112367E16148A286F" + }, + "type": "Microsoft.Network/virtualWans/p2sVpnServerConfigurations/p2sVpnServerConfigRadiusClientRootCertificates" + }] }, - "type": "Microsoft.Network/virtualWans/p2sVpnServerConfigurations" + "type": "Microsoft.Network/virtualWans/p2sVpnServerConfigurations" }, "201": { "name": "p2sVpnServerConfiguration1", @@ -123,7 +123,7 @@ "vpnProtocols": [ "IkeV2" ], - "vpnClientIpsecPolicies": [{ + "vpnClientIpsecPolicies": [{ "saLifeTimeSeconds": 86472, "saDataSizeKilobytes": 429497, "ipsecEncryption": "AES256", @@ -135,48 +135,48 @@ }], "p2SVpnServerConfigVpnClientRootCertificates": [{ "name": "p2sVpnServerConfigVpnClientRootCert1", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1/p2sVpnServerConfigurations/p2sVpnServerConfiguration1/p2sVpnServerConfigVpnClientRootCertificates/p2sVpnServerConfigVpnClientRootCert1", - "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1/p2sVpnServerConfigurations/p2sVpnServerConfiguration1/p2sVpnServerConfigVpnClientRootCertificates/p2sVpnServerConfigVpnClientRootCert1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", "properties": { - "provisioningState": "Succeeded", + "provisioningState": "Succeeded", "publicCertData": "MIIC5zCCAc+gAwIBAgIQErQ0Hk4aDJxIA+Q5RagB+jANBgkqhkiG9w0BAQsFADAWMRQwEgYDVQQDDAtQMlNSb290Q2VydDAeFw0xNzEyMTQyMTA3MzhaFw0xODEyMTQyMTI3MzhaMBYxFDASBgNVBAMMC1AyU1Jvb3RDZXJ0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEArP7/NQXmW7cQ/ZR1mv3Y3I29Lt7HTOqzo/1KUOoVH3NItbQIRAQbwKy3UWrOFz4eGNX2GWtNRMdCyWsKeqy9Ltsdfcm1IbKXkl84DFeU/ZacXu4Dl3xX3gV5du4TLZjEowJELyur11Ea2YcjPRQ/FzAF9/hGuboS1HZQEPLx4FdUs9OxCYOtc0MxBCwLfVTTRqarb0Ne+arNYd4kCzIhAke1nOyKAJBda5ZL+VHy3S5S8qGlD46jm8HXugmAkUygS4oIIXOmj/1O9sNAi3LN60zufSzCmP8Rm/iUGX+DHAGGiXxwZOKQLEDaZXKqoHjMPP0XudmSWwOIbyeQVrLhkwIDAQABozEwLzAOBgNVHQ8BAf8EBAMCAgQwHQYDVR0OBBYEFEfeNU2trYxNLF9ONmuJUsT13pKDMA0GCSqGSIb3DQEBCwUAA4IBAQBmM6RJzsGGipxyMhimHKN2xlkejhVsgBoTAhOU0llW9aUSwINJ9zFUGgI8IzUFy1VG776fchHp0LMRmPSIUYk5btEPxbsrPtumPuMH8EQGrS+Rt4pD+78c8H1fEPkq5CmDl/PKu4JoFGv+aFcE+Od0hlILstIF10Qysf++QXDolKfzJa/56bgMeYKFiju73loiRM57ns8ddXpfLl792UVpRkFU62LNns6Y1LKTwapmUF4IvIuAIzd6LZNOQng64LAKXtKnViJ1JQiXwf4CEzhgvAti3/ejpb3U90hsrUcyZi6wBv9bZLcAJRWpz61JNYliM1d1grSwQDKGXNQE4xuN" }, - "type": "Microsoft.Network/virtualWans/p2sVpnServerConfigurations/p2sVpnServerConfigVpnClientRootCertificates" + "type": "Microsoft.Network/virtualWans/p2sVpnServerConfigurations/p2sVpnServerConfigVpnClientRootCertificates" + }], + "p2SVpnServerConfigVpnClientRevokedCertificates": [{ + "name": "p2sVpnServerConfigVpnClientRevokedCert1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1/p2sVpnServerConfigurations/p2sVpnServerConfiguration1/p2sVpnServerConfigVpnClientRevokedCertificates/p2sVpnServerConfigVpnClientRevokedCert1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "Thumbprint": "83FFBFC8848B5A5836C94D0112367E16148A286F" + }, + "type": "Microsoft.Network/virtualWans/p2sVpnServerConfigurations/p2sVpnServerConfigVpnClientRevokedCertificates" }], - "p2SVpnServerConfigVpnClientRevokedCertificates": [{ - "name": "p2sVpnServerConfigVpnClientRevokedCert1", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1/p2sVpnServerConfigurations/p2sVpnServerConfiguration1/p2sVpnServerConfigVpnClientRevokedCertificates/p2sVpnServerConfigVpnClientRevokedCert1", - "etag": "w/\\00000000-0000-0000-0000-000000000000\\", - "properties": { - "provisioningState": "Succeeded", - "Thumbprint": "83FFBFC8848B5A5836C94D0112367E16148A286F" - }, - "type": "Microsoft.Network/virtualWans/p2sVpnServerConfigurations/p2sVpnServerConfigVpnClientRevokedCertificates" - }], - "radiusServerAddress": "8.9.9.9", - "radiusServerSecret":"123_abc", - "p2SVpnServerConfigRadiusServerRootCertificates": [{ + "radiusServerAddress": "8.9.9.9", + "radiusServerSecret":"123_abc", + "p2SVpnServerConfigRadiusServerRootCertificates": [{ "name": "p2sVpnServerConfigRadiusServerRootCert1", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1/p2sVpnServerConfigurations/p2sVpnServerConfiguration1/p2sVpnServerConfigRadiusServerRootCertificates/p2sVpnServerConfigRadiusServerRootCert1", - "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1/p2sVpnServerConfigurations/p2sVpnServerConfiguration1/p2sVpnServerConfigRadiusServerRootCertificates/p2sVpnServerConfigRadiusServerRootCert1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", "properties": { - "provisioningState": "Succeeded", + "provisioningState": "Succeeded", "publicCertData": "MIIC5zCCAc+gAwIBAgIQErQ0Hk4aDJxIA+Q5RagB+jANBgkqhkiG9w0BAQsFADAWMRQwEgYDVQQDDAtQMlNSb290Q2VydDAeFw0xNzEyMTQyMTA3MzhaFw0xODEyMTQyMTI3MzhaMBYxFDASBgNVBAMMC1AyU1Jvb3RDZXJ0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEArP7/NQXmW7cQ/ZR1mv3Y3I29Lt7HTOqzo/1KUOoVH3NItbQIRAQbwKy3UWrOFz4eGNX2GWtNRMdCyWsKeqy9Ltsdfcm1IbKXkl84DFeU/ZacXu4Dl3xX3gV5du4TLZjEowJELyur11Ea2YcjPRQ/FzAF9/hGuboS1HZQEPLx4FdUs9OxCYOtc0MxBCwLfVTTRqarb0Ne+arNYd4kCzIhAke1nOyKAJBda5ZL+VHy3S5S8qGlD46jm8HXugmAkUygS4oIIXOmj/1O9sNAi3LN60zufSzCmP8Rm/iUGX+DHAGGiXxwZOKQLEDaZXKqoHjMPP0XudmSWwOIbyeQVrLhkwIDAQABozEwLzAOBgNVHQ8BAf8EBAMCAgQwHQYDVR0OBBYEFEfeNU2trYxNLF9ONmuJUsT13pKDMA0GCSqGSIb3DQEBCwUAA4IBAQBmM6RJzsGGipxyMhimHKN2xlkejhVsgBoTAhOU0llW9aUSwINJ9zFUGgI8IzUFy1VG776fchHp0LMRmPSIUYk5btEPxbsrPtumPuMH8EQGrS+Rt4pD+78c8H1fEPkq5CmDl/PKu4JoFGv+aFcE+Od0hlILstIF10Qysf++QXDolKfzJa/56bgMeYKFiju73loiRM57ns8ddXpfLl792UVpRkFU62LNns6Y1LKTwapmUF4IvIuAIzd6LZNOQng64LAKXtKnViJ1JQiXwf4CEzhgvAti3/ejpb3U90hsrUcyZi6wBv9bZLcAJRWpz61JNYliM1d1grSwQDKGXNQE4xuM" }, - "type": "Microsoft.Network/virtualWans/p2sVpnServerConfigurations/p2sVpnServerConfigRadiusServerRootCertificates" + "type": "Microsoft.Network/virtualWans/p2sVpnServerConfigurations/p2sVpnServerConfigRadiusServerRootCertificates" }], - "p2SVpnServerConfigRadiusClientRootCertificates": [{ - "name": "p2sVpnServerConfigRadiusClientRootCert1", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1/p2sVpnServerConfigurations/p2sVpnServerConfiguration1/p2sVpnServerConfigRadiusClientRootCertificates/p2sVpnServerConfigRadiusClientRootCert1", - "etag": "w/\\00000000-0000-0000-0000-000000000000\\", - "properties": { - "provisioningState": "Succeeded", - "Thumbprint": "83FFBFC8848B5A5836C94D0112367E16148A286F" - }, - "type": "Microsoft.Network/virtualWans/p2sVpnServerConfigurations/p2sVpnServerConfigRadiusClientRootCertificates" - }] + "p2SVpnServerConfigRadiusClientRootCertificates": [{ + "name": "p2sVpnServerConfigRadiusClientRootCert1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1/p2sVpnServerConfigurations/p2sVpnServerConfiguration1/p2sVpnServerConfigRadiusClientRootCertificates/p2sVpnServerConfigRadiusClientRootCert1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "Thumbprint": "83FFBFC8848B5A5836C94D0112367E16148A286F" + }, + "type": "Microsoft.Network/virtualWans/p2sVpnServerConfigurations/p2sVpnServerConfigRadiusClientRootCertificates" + }] }, - "type": "Microsoft.Network/virtualWans/p2sVpnServerConfigurations" + "type": "Microsoft.Network/virtualWans/p2sVpnServerConfigurations" } } } diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/PeerExpressRouteCircuitConnectionList.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/PeerExpressRouteCircuitConnectionList.json index f4995e2f20ad..279f278da2d0 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/PeerExpressRouteCircuitConnectionList.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/PeerExpressRouteCircuitConnectionList.json @@ -1,53 +1,53 @@ { - "parameters": { - "resourceGroupName": "rg1", - "api-version": "2019-04-01", - "subscriptionId": "subid1", - "circuitName": "ExpressRouteARMCircuitA", - "peeringName": "AzurePrivatePeering" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "name": "60aee347-e889-4a42-8c1b-0aae8b1e4013", - "id": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/ExpressRouteARMCircuitA/peerings/AzurePrivatePeering/peerConnections/60aee347-e889-4a42-8c1b-0aae8b1e4013", - "etag": "W/\"6ffbbb06-da20-44ca-a34f-280c4653b1e9\"", - "properties": { - "provisioningState": "Succeeded", - "expressRouteCircuitPeering": { - "id": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/ExpressRouteARMCircuitA/peerings/AzurePrivatePeering" - }, - "peerExpressRouteCircuitPeering": { - "id": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/ExpressRouteARMCircuitB/peerings/AzurePrivatePeering" - }, - "addressPrefix": "20.0.0.0/29", - "circuitConnectionStatus": "Connected", - "connectionName": "circuitConnectionWestusEastus", - "authResourceGuid": "" - } + "parameters": { + "resourceGroupName": "rg1", + "api-version": "2019-04-01", + "subscriptionId": "subid1", + "circuitName": "ExpressRouteARMCircuitA", + "peeringName": "AzurePrivatePeering" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "60aee347-e889-4a42-8c1b-0aae8b1e4013", + "id": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/ExpressRouteARMCircuitA/peerings/AzurePrivatePeering/peerConnections/60aee347-e889-4a42-8c1b-0aae8b1e4013", + "etag": "W/\"6ffbbb06-da20-44ca-a34f-280c4653b1e9\"", + "properties": { + "provisioningState": "Succeeded", + "expressRouteCircuitPeering": { + "id": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/ExpressRouteARMCircuitA/peerings/AzurePrivatePeering" }, - { - "name": "c8b17193-8dd3-4f61-866d-8cdd2e2e268e", - "id": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/ExpressRouteARMCircuitA/peerings/AzurePrivatePeering/peerConnections/c8b17193-8dd3-4f61-866d-8cdd2e2e268e", - "etag": "W/\"6ffbbb06-da20-44ca-a34f-280c4653b1e9\"", - "properties": { - "provisioningState": "Succeeded", - "expressRouteCircuitPeering": { - "id": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/ExpressRouteARMCircuitA/peerings/AzurePrivatePeering" - }, - "peerExpressRouteCircuitPeering": { - "id": "/subscriptions/subid2/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/ExpressRouteARMCircuitC/peerings/AzurePrivatePeering" - }, - "addressPrefix": "30.0.0.0/29", - "circuitConnectionStatus": "Connected", - "connectionName": "circuitConnectionCentralusEastus", - "authResourceGuid": "64283012-d377-421d-8398-f6aeb2ac7ea0" - } - } - ] - } + "peerExpressRouteCircuitPeering": { + "id": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/ExpressRouteARMCircuitB/peerings/AzurePrivatePeering" + }, + "addressPrefix": "20.0.0.0/29", + "circuitConnectionStatus": "Connected", + "connectionName": "circuitConnectionWestusEastus", + "authResourceGuid": "" + } + }, + { + "name": "c8b17193-8dd3-4f61-866d-8cdd2e2e268e", + "id": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/ExpressRouteARMCircuitA/peerings/AzurePrivatePeering/peerConnections/c8b17193-8dd3-4f61-866d-8cdd2e2e268e", + "etag": "W/\"6ffbbb06-da20-44ca-a34f-280c4653b1e9\"", + "properties": { + "provisioningState": "Succeeded", + "expressRouteCircuitPeering": { + "id": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/ExpressRouteARMCircuitA/peerings/AzurePrivatePeering" + }, + "peerExpressRouteCircuitPeering": { + "id": "/subscriptions/subid2/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/ExpressRouteARMCircuitC/peerings/AzurePrivatePeering" + }, + "addressPrefix": "30.0.0.0/29", + "circuitConnectionStatus": "Connected", + "connectionName": "circuitConnectionCentralusEastus", + "authResourceGuid": "64283012-d377-421d-8398-f6aeb2ac7ea0" + } + } + ] } } - } \ No newline at end of file + } +} \ No newline at end of file diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/PublicIpPrefixCreateCustomizedValues.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/PublicIpPrefixCreateCustomizedValues.json index 6a8e583b9df3..5dcee069d43b 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/PublicIpPrefixCreateCustomizedValues.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/PublicIpPrefixCreateCustomizedValues.json @@ -1,54 +1,54 @@ { - "parameters" : { - "api-version": "2019-04-01", - "subscriptionId" : "subid", - "resourceGroupName": "rg1", - "publicIpPrefixName": "test-ipprefix", - "zones": [ "1" ], - "parameters": { - "properties": { - "publicIPAddressVersion": "IPv4", + "parameters" : { + "api-version": "2019-04-01", + "subscriptionId" : "subid", + "resourceGroupName": "rg1", + "publicIpPrefixName": "test-ipprefix", + "zones": [ "1" ], + "parameters": { + "properties": { + "publicIPAddressVersion": "IPv4", + "prefixLength":30 + }, + "sku": { + "name": "Standard" + } + } + }, + "responses" : { + "200" : { + "body" : { + "name" : "test-ipprefix", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPPrefixes/test-ipprefix", + "location" : "westus", + "zones": [ "1" ], + "properties" : { + "provisioningState" : "Succeeded", + "publicIPAddressVersion" : "IPv4", "prefixLength":30 }, "sku": { - "name": "Standard" - } + "name": "Standard" + }, + "type" : "Microsoft.Network/publicIPPrefixes" } }, - "responses" : { - "200" : { - "body" : { - "name" : "test-ipprefix", - "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPPrefixes/test-ipprefix", - "location" : "westus", - "zones": [ "1" ], - "properties" : { - "provisioningState" : "Succeeded", - "publicIPAddressVersion" : "IPv4", - "prefixLength":30 - }, - "sku": { - "name": "Standard" - }, - "type" : "Microsoft.Network/publicIPPrefixes" - } - }, - "201" : { - "body" : { - "name" : "test-ipprefix", - "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ipprefix", - "location" : "westus", - "zones": [ "1" ], - "properties" : { - "provisioningState" : "Succeeded", - "publicIPAddressVersion" : "IPv4", - "prefixLength":30 - }, - "sku": { - "name": "Standard" - }, - "type" : "Microsoft.Network/publicIPPrefixes" - } + "201" : { + "body" : { + "name" : "test-ipprefix", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ipprefix", + "location" : "westus", + "zones": [ "1" ], + "properties" : { + "provisioningState" : "Succeeded", + "publicIPAddressVersion" : "IPv4", + "prefixLength":30 + }, + "sku": { + "name": "Standard" + }, + "type" : "Microsoft.Network/publicIPPrefixes" } } - } \ No newline at end of file + } +} \ No newline at end of file diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/PublicIpPrefixCreateDefaults.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/PublicIpPrefixCreateDefaults.json index 155d925df962..f4f152cddee3 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/PublicIpPrefixCreateDefaults.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/PublicIpPrefixCreateDefaults.json @@ -1,43 +1,43 @@ { - "parameters" : { - "api-version": "2019-04-01", - "subscriptionId" : "subid", - "resourceGroupName": "rg1", - "publicIpPrefixName": "test-ipprefix", - "parameters": {} + "parameters" : { + "api-version": "2019-04-01", + "subscriptionId" : "subid", + "resourceGroupName": "rg1", + "publicIpPrefixName": "test-ipprefix", + "parameters": {} + }, + "responses" : { + "200" : { + "body" : { + "name" : "test-ipprefix", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPPrefixes/test-ipprefix", + "location" : "westus", + "properties" : { + "provisioningState" : "Succeeded", + "publicIPAddressVersion" : "IPv4", + "prefixLength":30 + }, + "sku": { + "name": "Standard" + }, + "type" : "Microsoft.Network/publicIPPrefixes" + } }, - "responses" : { - "200" : { - "body" : { - "name" : "test-ipprefix", - "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPPrefixes/test-ipprefix", - "location" : "westus", - "properties" : { - "provisioningState" : "Succeeded", - "publicIPAddressVersion" : "IPv4", - "prefixLength":30 - }, - "sku": { - "name": "Standard" - }, - "type" : "Microsoft.Network/publicIPPrefixes" - } - }, - "201" : { - "body" : { - "name" : "test-ipprefix", - "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPPrefixes/test-ipprefix", - "location" : "westus", - "properties" : { - "provisioningState" : "Succeeded", - "publicIPAddressVersion" : "IPv4", - "prefixLength":30 - }, - "sku": { - "name": "Standard" - }, - "type" : "Microsoft.Network/publicIPPrefixes" - } + "201" : { + "body" : { + "name" : "test-ipprefix", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPPrefixes/test-ipprefix", + "location" : "westus", + "properties" : { + "provisioningState" : "Succeeded", + "publicIPAddressVersion" : "IPv4", + "prefixLength":30 + }, + "sku": { + "name": "Standard" + }, + "type" : "Microsoft.Network/publicIPPrefixes" } } - } \ No newline at end of file + } +} \ No newline at end of file diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/PublicIpPrefixDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/PublicIpPrefixDelete.json index a1004fb2dfb4..84095ea9a0bc 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/PublicIpPrefixDelete.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/PublicIpPrefixDelete.json @@ -1,13 +1,13 @@ { - "parameters" : { - "api-version": "2019-04-01", - "subscriptionId" : "subid", - "resourceGroupName": "rg1", - "publicIpPrefixName": "test-ipprefix" - }, - "responses" : { - "200" : { }, - "202" : { }, - "204" : { } - } - } \ No newline at end of file + "parameters" : { + "api-version": "2019-04-01", + "subscriptionId" : "subid", + "resourceGroupName": "rg1", + "publicIpPrefixName": "test-ipprefix" + }, + "responses" : { + "200" : { }, + "202" : { }, + "204" : { } + } +} \ No newline at end of file diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/PublicIpPrefixGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/PublicIpPrefixGet.json index 50253831b28f..5eb43b14f970 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/PublicIpPrefixGet.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/PublicIpPrefixGet.json @@ -1,32 +1,31 @@ { - "parameters" : { - "api-version": "2019-04-01", - "subscriptionId" : "subid", - "resourceGroupName": "rg1", - "publicIpPrefixName": "test-ipprefix" - }, - "responses" : { - "200" : { - "body" : { - "name" : "test-ipprefix", - "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPPrefixes/test-ipprefix", - "location" : "westus", - "properties" : { - "provisioningState" : "Succeeded", - "publicIPAddressVersion" : "IPv4", - "prefixLength":30, - "ipPrefix":"192.168.254.2/30", - "ipTags" : [ - ], - "publicIPAddresses": [ - { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/PublicIpAddress1" - } - ] - }, - "type" : "Microsoft.Network/publicIPPrefixes" - } + "parameters" : { + "api-version": "2019-04-01", + "subscriptionId" : "subid", + "resourceGroupName": "rg1", + "publicIpPrefixName": "test-ipprefix" + }, + "responses" : { + "200" : { + "body" : { + "name" : "test-ipprefix", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPPrefixes/test-ipprefix", + "location" : "westus", + "properties" : { + "provisioningState" : "Succeeded", + "publicIPAddressVersion" : "IPv4", + "prefixLength":30, + "ipPrefix":"192.168.254.2/30", + "ipTags" : [ + ], + "publicIPAddresses": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/PublicIpAddress1" + } + ] + }, + "type" : "Microsoft.Network/publicIPPrefixes" } } } - \ No newline at end of file +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/PublicIpPrefixList.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/PublicIpPrefixList.json index 571ad12adb75..002447d2693d 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/PublicIpPrefixList.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/PublicIpPrefixList.json @@ -1,45 +1,45 @@ { - "parameters" : { - "api-version": "2019-04-01", - "subscriptionId" : "subid", - "resourceGroupName": "rg1" - }, - "responses" : { - "200" : { - "body" : { - "value" : [ - { - "name" : "test-ipprefix", - "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPPrefixes/test-ipprefix", - "location" : "westus", - "properties" : { - "provisioningState" : "Succeeded", - "publicIPAddressVersion" : "IPv4", - "prefixLength":30, - "ipPrefix":"40.85.154.2/30", - "ipTags" : [ - { - "ipTagType" : "FirstPartyUsage", - "tag" : "SQL" - } - ] - }, - "type" : "Microsoft.Network/publicIPPrefixes" - }, - { - "name" : "ipprefix03", - "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPPrefixes/ipprefix03", - "location" : "westus", - "properties" : { - "provisioningState" : "Succeeded", - "publicIPAddressVersion" : "IPv4", - "prefixLength":31, - "ipPrefix" : "40.85.153.2/31" + "parameters" : { + "api-version": "2019-04-01", + "subscriptionId" : "subid", + "resourceGroupName": "rg1" + }, + "responses" : { + "200" : { + "body" : { + "value" : [ + { + "name" : "test-ipprefix", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPPrefixes/test-ipprefix", + "location" : "westus", + "properties" : { + "provisioningState" : "Succeeded", + "publicIPAddressVersion" : "IPv4", + "prefixLength":30, + "ipPrefix":"40.85.154.2/30", + "ipTags" : [ + { + "ipTagType" : "FirstPartyUsage", + "tag" : "SQL" + } + ] }, - "type" : "Microsoft.Network/publicIPPrefixes" - } - ] - } + "type" : "Microsoft.Network/publicIPPrefixes" + }, + { + "name" : "ipprefix03", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPPrefixes/ipprefix03", + "location" : "westus", + "properties" : { + "provisioningState" : "Succeeded", + "publicIPAddressVersion" : "IPv4", + "prefixLength":31, + "ipPrefix" : "40.85.153.2/31" + }, + "type" : "Microsoft.Network/publicIPPrefixes" + } + ] } } + } } \ No newline at end of file diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/PublicIpPrefixListAll.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/PublicIpPrefixListAll.json index a6cd15bd1b99..8f0443eaa266 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/PublicIpPrefixListAll.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/PublicIpPrefixListAll.json @@ -1,44 +1,43 @@ { - "parameters" : { - "api-version": "2019-04-01", - "subscriptionId" : "subid" - }, - "responses" : { - "200" : { - "body" : { - "value" : [ - { - "name" : "test-ipprefix", - "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPPrefixes/test-ipprefix", - "location" : "westus", - "properties" : { - "provisioningState" : "Succeeded", - "publicIPAddressVersion" : "IPv4", - "prefixLength":30, - "ipPrefix":"41.85.154.247/30", - "publicIPAddresses": [ - { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/PublicIpAddress1" - } - ] - }, - "type" : "Microsoft.Network/publicIPPrefixes" + "parameters" : { + "api-version": "2019-04-01", + "subscriptionId" : "subid" + }, + "responses" : { + "200" : { + "body" : { + "value" : [ + { + "name" : "test-ipprefix", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPPrefixes/test-ipprefix", + "location" : "westus", + "properties" : { + "provisioningState" : "Succeeded", + "publicIPAddressVersion" : "IPv4", + "prefixLength":30, + "ipPrefix":"41.85.154.247/30", + "publicIPAddresses": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/PublicIpAddress1" + } + ] }, - { - "name" : "ipprefix01", - "id" : "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/publicIPPrefixes/ipprefix01", - "location" : "westus", - "properties" : { - "provisioningState" : "Succeeded", - "ipPrefix" : "40.85.154.247/30", - "publicIPAddressVersion" : "IPv4", - "prefixLength":30 - }, - "type" : "Microsoft.Network/publicIPPrefixes" - } - ] - } + "type" : "Microsoft.Network/publicIPPrefixes" + }, + { + "name" : "ipprefix01", + "id" : "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/publicIPPrefixes/ipprefix01", + "location" : "westus", + "properties" : { + "provisioningState" : "Succeeded", + "ipPrefix" : "40.85.154.247/30", + "publicIPAddressVersion" : "IPv4", + "prefixLength":30 + }, + "type" : "Microsoft.Network/publicIPPrefixes" + } + ] } } } - \ No newline at end of file +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/PublicIpPrefixUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/PublicIpPrefixUpdateTags.json index 0e89a4969a7f..c2ab4b63d239 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/PublicIpPrefixUpdateTags.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/PublicIpPrefixUpdateTags.json @@ -1,33 +1,33 @@ { - "parameters" : { - "api-version": "2019-04-01", - "subscriptionId" : "subid", - "resourceGroupName": "rg1", - "publicIpPrefixName": "test-ipprefix", - "parameters": { + "parameters" : { + "api-version": "2019-04-01", + "subscriptionId" : "subid", + "resourceGroupName": "rg1", + "publicIpPrefixName": "test-ipprefix", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses" : { + "200" : { + "body" : { + "name" : "test-ipprefix", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPPrefixes/test-ipprefix", + "location" : "westus", + "properties" : { + "provisioningState" : "Succeeded", + "publicIPAddressVersion" : "IPv4", + "prefixLength":30 + }, "tags": { "tag1": "value1", "tag2": "value2" - } - } - }, - "responses" : { - "200" : { - "body" : { - "name" : "test-ipprefix", - "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPPrefixes/test-ipprefix", - "location" : "westus", - "properties" : { - "provisioningState" : "Succeeded", - "publicIPAddressVersion" : "IPv4", - "prefixLength":30 - }, - "tags": { - "tag1": "value1", - "tag2": "value2" - }, - "type" : "Microsoft.Network/publicIPPrefixes" - } + }, + "type" : "Microsoft.Network/publicIPPrefixes" } } - } \ No newline at end of file + } +} \ No newline at end of file diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/RouteFilterList.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/RouteFilterList.json index e51a1e5f8c9a..c188c6c1985b 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/RouteFilterList.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/RouteFilterList.json @@ -35,7 +35,7 @@ } ], "peerings": [] - } + } } ] } diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/RouteFilterListByResourceGroup.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/RouteFilterListByResourceGroup.json index 52f77b750c72..a38b8cbfdaa3 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/RouteFilterListByResourceGroup.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/RouteFilterListByResourceGroup.json @@ -36,7 +36,7 @@ } ], "peerings": [] - } + } } ] } diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/ServiceEndpointPolicyCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/ServiceEndpointPolicyCreate.json index 958872ff7921..9d912839861d 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/ServiceEndpointPolicyCreate.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/ServiceEndpointPolicyCreate.json @@ -13,7 +13,7 @@ "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/ServiceEndpointPolicies/testpolicy", "type": "Microsoft.Network/ServiceEndpointPolicies", "location": "westus", - "properties": + "properties": { "serviceEndpointPolicyDefinitions": [ ], "subnets": [ ], @@ -28,7 +28,7 @@ "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testpolicy", "type": "Microsoft.Network/ServiceEndpointPolicies", "location": "westus", - "properties": + "properties": { "serviceEndpointPolicyDefinitions": [], "subnets": [ ], diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/ServiceEndpointPolicyCreateWithDefinition.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/ServiceEndpointPolicyCreateWithDefinition.json index 597ce63a3d9a..309810942f32 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/ServiceEndpointPolicyCreateWithDefinition.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/ServiceEndpointPolicyCreateWithDefinition.json @@ -30,7 +30,7 @@ "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/ServiceEndpointPolicies/testpolicy", "type": "Microsoft.Network/ServiceEndpointPolicies", "location": "westus", - "properties": + "properties": { "serviceEndpointPolicyDefinitions": [ { @@ -58,7 +58,7 @@ "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/ServiceEndpointPolicies/testpolicy", "type": "Microsoft.Network/ServiceEndpointPolicies", "location": "westus", - "properties": + "properties": { "serviceEndpointPolicyDefinitions": [ { diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/ServiceEndpointPolicyGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/ServiceEndpointPolicyGet.json index c1cfdc340bd3..a6ba5503eb25 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/ServiceEndpointPolicyGet.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/ServiceEndpointPolicyGet.json @@ -12,7 +12,7 @@ "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/serviceEndpointPolicies/testServiceEndpointPolicy", "type": "Microsoft.Network/serviceEndpointPolicies", "location" : "westus", - "properties": + "properties": { "serviceEndpointPolicyDefinitions": [ { diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/ServiceEndpointPolicyList.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/ServiceEndpointPolicyList.json index a6e74b45a4a4..122979b82039 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/ServiceEndpointPolicyList.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/ServiceEndpointPolicyList.json @@ -12,7 +12,7 @@ "name" : "testServiceEndpointPolicy", "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/serviceEndpointPolicies/testServiceEndpointPolicy", "location" : "westus", - "properties": + "properties": { "serviceEndpointPolicyDefinitions": [ { @@ -37,7 +37,7 @@ "name" : "testServiceEndpointPolicy1", "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/serviceEndpointPolicies/testServiceEndpointPolicy1", "location" : "westus", - "properties": + "properties": { "serviceEndpointPolicyDefinitions": [ { diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/ServiceEndpointPolicyListAll.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/ServiceEndpointPolicyListAll.json index f1ee118ff728..ba0c6606f28e 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/ServiceEndpointPolicyListAll.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/ServiceEndpointPolicyListAll.json @@ -12,7 +12,7 @@ "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/serviceEndpointPolicies/testPolicy", "type": "Microsoft.Network/serviceEndpointPolicies", "location": "westus", - "properties": + "properties": { "serviceEndpointPolicyDefinitions": [ { @@ -38,7 +38,7 @@ "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/serviceEndpointPolicies/testPolicy2", "type": "Microsoft.Network/serviceEndpointPolicies", "location": "westus", - "properties": + "properties": { "serviceEndpointPolicyDefinitions": [ { diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/SubnetCreateWithDelegation.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/SubnetCreateWithDelegation.json index 0756e7c580a4..1b9c654d1dea 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/SubnetCreateWithDelegation.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/SubnetCreateWithDelegation.json @@ -1,60 +1,60 @@ -{ - "parameters": { - "subnetName": "subnet1", - "virtualNetworkName": "vnetname", - "resourceGroupName": "subnet-test", - "api-version": "2019-04-01", - "subscriptionId": "subId", - "subnetParameters": { - "properties": { - "addressPrefix": "10.0.0.0/16" - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/subId/resourceGroups/subnet-test/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/subnet1", - "name": "subnet1", - "properties": { - "addressPrefix": "10.0.0.0/16", - "provisioningState": "Succeeded", - "delegations": [ - { - "name": "myDelegation", - "id": "/subscriptions/subId/resourceGroups/subnet-test/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/subnet1/delegations/myDelegation", - "properties": { - "provisioningState": "Succeeded", - "serviceName": "Microsoft.Provider/resourceType", - "actions": [] - } - } - ], - "purpose": "" - } - } - }, - "201": { - "body": { - "id": "/subscriptions/subId/resourceGroups/subnet-test/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/subnet1", - "name": "subnet1", - "properties": { - "addressPrefix": "10.0.0.0/16", - "provisioningState": "Succeeded", - "delegations": [ - { - "name": "myDelegation", - "id": "/subscriptions/subId/resourceGroups/subnet-test/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/subnet1/delegations/myDelegation", - "properties": { - "provisioningState": "Succeeded", - "serviceName": "Microsoft.Provider/resourceType", - "actions": [] - } - } - ], - "purpose": "" - } - } - } - } -} +{ + "parameters": { + "subnetName": "subnet1", + "virtualNetworkName": "vnetname", + "resourceGroupName": "subnet-test", + "api-version": "2019-04-01", + "subscriptionId": "subId", + "subnetParameters": { + "properties": { + "addressPrefix": "10.0.0.0/16" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subId/resourceGroups/subnet-test/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/subnet1", + "name": "subnet1", + "properties": { + "addressPrefix": "10.0.0.0/16", + "provisioningState": "Succeeded", + "delegations": [ + { + "name": "myDelegation", + "id": "/subscriptions/subId/resourceGroups/subnet-test/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/subnet1/delegations/myDelegation", + "properties": { + "provisioningState": "Succeeded", + "serviceName": "Microsoft.Provider/resourceType", + "actions": [] + } + } + ], + "purpose": "" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subId/resourceGroups/subnet-test/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/subnet1", + "name": "subnet1", + "properties": { + "addressPrefix": "10.0.0.0/16", + "provisioningState": "Succeeded", + "delegations": [ + { + "name": "myDelegation", + "id": "/subscriptions/subId/resourceGroups/subnet-test/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/subnet1/delegations/myDelegation", + "properties": { + "provisioningState": "Succeeded", + "serviceName": "Microsoft.Provider/resourceType", + "actions": [] + } + } + ], + "purpose": "" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/SubnetGetWithDelegation.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/SubnetGetWithDelegation.json index fec4a300f8b8..2635c9f68f6a 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/SubnetGetWithDelegation.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/SubnetGetWithDelegation.json @@ -1,33 +1,33 @@ -{ - "parameters": { - "subnetName": "subnet1", - "virtualNetworkName": "vnetname", - "resourceGroupName": "subnet-test", - "api-version": "2019-04-01", - "subscriptionId": "subId" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/subId/resourceGroups/subnet-test/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/subnet1", - "name": "subnet1", - "properties": { - "addressPrefix": "10.0.0.0/16", - "provisioningState": "Succeeded", - "delegations": [ - { - "name": "myDelegation", - "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1/delegations/myDelegation", - "properties": { - "provisioningState": "Succeeded", - "serviceName": "Microsoft.Provider/resourceType", - "actions": [] - } - } - ], - "purpose": "" - } - } - } - } -} +{ + "parameters": { + "subnetName": "subnet1", + "virtualNetworkName": "vnetname", + "resourceGroupName": "subnet-test", + "api-version": "2019-04-01", + "subscriptionId": "subId" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subId/resourceGroups/subnet-test/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/subnet1", + "name": "subnet1", + "properties": { + "addressPrefix": "10.0.0.0/16", + "provisioningState": "Succeeded", + "delegations": [ + { + "name": "myDelegation", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1/delegations/myDelegation", + "properties": { + "provisioningState": "Succeeded", + "serviceName": "Microsoft.Provider/resourceType", + "actions": [] + } + } + ], + "purpose": "" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/VirtualHubPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/VirtualHubPut.json index fbf239f32c2c..1acc061f124a 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/VirtualHubPut.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/VirtualHubPut.json @@ -13,7 +13,7 @@ "virtualWan": { "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1" }, - "addressPrefix": "10.168.0.0/24" + "addressPrefix": "10.168.0.0/24" } } }, diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/VirtualNetworkCreateSubnetWithDelegation.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/VirtualNetworkCreateSubnetWithDelegation.json index fa03f07cb46c..a486022bcc98 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/VirtualNetworkCreateSubnetWithDelegation.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/VirtualNetworkCreateSubnetWithDelegation.json @@ -1,114 +1,114 @@ -{ - "parameters" : { - "api-version": "2019-04-01", - "subscriptionId" : "subId", - "resourceGroupName" : "rg1", - "virtualNetworkName" : "test-vnet", - "parameters": { - "properties": { - "addressSpace": { - "addressPrefixes": [ - "10.0.0.0/16" - ] - }, - "subnets": [ - { - "name": "test-1", - "properties": { - "addressPrefix": "10.0.0.0/24", - "delegations": [ - { - "name": "myDelegation", - "properties": { - "serviceName": "Microsoft.Provider/resourceType" - } - } - ] - } - } - ] - }, - "location": "eastus" - } - }, - "responses" : { - "200" : { - "body" : { - "name" : "test-vnet", - "id" : "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet", - "type" : "Microsoft.Network/virtualNetworks", - "location" : "eastus", - "properties" : { - "provisioningState" : "Succeeded", - "addressSpace" : { - "addressPrefixes" : [ - "10.0.0.0/16" - ] - }, - "subnets": [ - { - "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-1", - "name": "test-1", - "properties": { - "addressPrefix": "10.0.0.0/24", - "provisioningState": "Succeeded", - "delegations": [ - { - "name": "myDelegation", - "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-1/delegations/myDelegation", - "properties": { - "provisioningState": "Succeeded", - "serviceName": "Microsoft.Provider/resourceType", - "actions": [] - } - } - ], - "purpose": "" - } - } - ], - "virtualNetworkPeerings" : [] - } - } - }, - "201" : { - "body" : { - "name" : "test-vnet", - "id" : "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet", - "type" : "Microsoft.Network/virtualNetworks", - "location" : "eastus", - "properties" : { - "provisioningState" : "Succeeded", - "addressSpace" : { - "addressPrefixes" : [ - "10.0.0.0/16" - ] - }, - "subnets": [ - { - "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-1", - "name": "test-1", - "properties": { - "addressPrefix": "10.0.0.0/24", - "provisioningState": "Succeeded", - "delegations": [ - { - "name": "myDelegation", - "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-1/delegations/myDelegation", - "properties": { - "provisioningState": "Succeeded", - "serviceName": "Microsoft.Provider/resourceType", - "actions": [] - } - } - ], - "purpose": "" - } - } - ], - "virtualNetworkPeerings" : [] - } - } - } - } -} +{ + "parameters" : { + "api-version": "2019-04-01", + "subscriptionId" : "subId", + "resourceGroupName" : "rg1", + "virtualNetworkName" : "test-vnet", + "parameters": { + "properties": { + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "subnets": [ + { + "name": "test-1", + "properties": { + "addressPrefix": "10.0.0.0/24", + "delegations": [ + { + "name": "myDelegation", + "properties": { + "serviceName": "Microsoft.Provider/resourceType" + } + } + ] + } + } + ] + }, + "location": "eastus" + } + }, + "responses" : { + "200" : { + "body" : { + "name" : "test-vnet", + "id" : "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet", + "type" : "Microsoft.Network/virtualNetworks", + "location" : "eastus", + "properties" : { + "provisioningState" : "Succeeded", + "addressSpace" : { + "addressPrefixes" : [ + "10.0.0.0/16" + ] + }, + "subnets": [ + { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-1", + "name": "test-1", + "properties": { + "addressPrefix": "10.0.0.0/24", + "provisioningState": "Succeeded", + "delegations": [ + { + "name": "myDelegation", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-1/delegations/myDelegation", + "properties": { + "provisioningState": "Succeeded", + "serviceName": "Microsoft.Provider/resourceType", + "actions": [] + } + } + ], + "purpose": "" + } + } + ], + "virtualNetworkPeerings" : [] + } + } + }, + "201" : { + "body" : { + "name" : "test-vnet", + "id" : "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet", + "type" : "Microsoft.Network/virtualNetworks", + "location" : "eastus", + "properties" : { + "provisioningState" : "Succeeded", + "addressSpace" : { + "addressPrefixes" : [ + "10.0.0.0/16" + ] + }, + "subnets": [ + { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-1", + "name": "test-1", + "properties": { + "addressPrefix": "10.0.0.0/24", + "provisioningState": "Succeeded", + "delegations": [ + { + "name": "myDelegation", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-1/delegations/myDelegation", + "properties": { + "provisioningState": "Succeeded", + "serviceName": "Microsoft.Provider/resourceType", + "actions": [] + } + } + ], + "purpose": "" + } + } + ], + "virtualNetworkPeerings" : [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/VirtualNetworkGatewayGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/VirtualNetworkGatewayGet.json index d5b45d8bd404..b339158bcd3d 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/VirtualNetworkGatewayGet.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/VirtualNetworkGatewayGet.json @@ -48,9 +48,9 @@ "peerWeight": 0 }, "customRoutes": { - "addressPrefixes": [ - "101.168.0.6/32" - ] + "addressPrefixes": [ + "101.168.0.6/32" + ] } } } diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/VirtualNetworkGatewayGetVpnClientIpsecParameters.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/VirtualNetworkGatewayGetVpnClientIpsecParameters.json index bf694a09c3f0..336542054c93 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/VirtualNetworkGatewayGetVpnClientIpsecParameters.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/VirtualNetworkGatewayGetVpnClientIpsecParameters.json @@ -7,14 +7,14 @@ }, "responses" : { "200" : { - "saLifeTimeSeconds": 86473, - "saDataSizeKilobytes": 429497, - "ipsecEncryption": "AES256", - "ipsecIntegrity": "SHA256", - "ikeEncryption": "AES256", - "ikeIntegrity": "SHA384", - "dhGroup": "DHGroup2", - "pfsGroup": "PFS2" + "saLifeTimeSeconds": 86473, + "saDataSizeKilobytes": 429497, + "ipsecEncryption": "AES256", + "ipsecIntegrity": "SHA256", + "ikeEncryption": "AES256", + "ikeIntegrity": "SHA384", + "dhGroup": "DHGroup2", + "pfsGroup": "PFS2" } } } diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/VirtualNetworkGatewayList.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/VirtualNetworkGatewayList.json index 8ada379c5afa..33928aa64b5a 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/VirtualNetworkGatewayList.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/VirtualNetworkGatewayList.json @@ -53,12 +53,12 @@ "bgpPeeringAddress": "10.0.0.14", "peerWeight": 0 }, - "customRoutes": { - "addressPrefixes": [ - "101.168.0.6/32" - ] - } - } + "customRoutes": { + "addressPrefixes": [ + "101.168.0.6/32" + ] + } + } }, { "name": "vpngw2", @@ -105,11 +105,11 @@ "bgpPeeringAddress": "10.1.0.46", "peerWeight": 0 }, - "customRoutes": { - "addressPrefixes": [ - "101.168.0.6/32" - ] - } + "customRoutes": { + "addressPrefixes": [ + "101.168.0.6/32" + ] + } } } ] diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/VirtualNetworkGatewayReset.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/VirtualNetworkGatewayReset.json index 84f4fe0e5634..a45c9dd2932e 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/VirtualNetworkGatewayReset.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/VirtualNetworkGatewayReset.json @@ -48,11 +48,11 @@ "bgpPeeringAddress": "10.0.1.30", "peerWeight": 0 }, - "customRoutes": { - "addressPrefixes": [ - "101.168.0.6/32" - ] - } + "customRoutes": { + "addressPrefixes": [ + "101.168.0.6/32" + ] + } } } } diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/VirtualNetworkGatewaySetVpnClientIpsecParameters.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/VirtualNetworkGatewaySetVpnClientIpsecParameters.json index c76725fda517..eceb7a44c0cc 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/VirtualNetworkGatewaySetVpnClientIpsecParameters.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/VirtualNetworkGatewaySetVpnClientIpsecParameters.json @@ -5,14 +5,14 @@ "resourceGroupName": "rg1", "virtualNetworkGatewayName" : "vpngw", "vpnclientIpsecParams": { - "saLifeTimeSeconds": 86473, - "saDataSizeKilobytes": 429497, - "ipsecEncryption": "AES256", - "ipsecIntegrity": "SHA256", - "ikeEncryption": "AES256", - "ikeIntegrity": "SHA384", - "dhGroup": "DHGroup2", - "pfsGroup": "PFS2" + "saLifeTimeSeconds": 86473, + "saDataSizeKilobytes": 429497, + "ipsecEncryption": "AES256", + "ipsecIntegrity": "SHA256", + "ikeEncryption": "AES256", + "ikeIntegrity": "SHA384", + "dhGroup": "DHGroup2", + "pfsGroup": "PFS2" } }, "responses" : { diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/VirtualNetworkGatewayUpdate.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/VirtualNetworkGatewayUpdate.json index ec7ceb7ff895..dba9fc9e74fb 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/VirtualNetworkGatewayUpdate.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/VirtualNetworkGatewayUpdate.json @@ -33,11 +33,11 @@ "bgpPeeringAddress": "10.0.1.30", "peerWeight": 0 }, - "customRoutes": { - "addressPrefixes": [ - "101.168.0.6/32" - ] - } + "customRoutes": { + "addressPrefixes": [ + "101.168.0.6/32" + ] + } }, "location": "centralus" } @@ -92,11 +92,11 @@ "bgpPeeringAddress": "10.0.1.30", "peerWeight": 0 }, - "customRoutes": { - "addressPrefixes": [ - "101.168.0.6/32" - ] - } + "customRoutes": { + "addressPrefixes": [ + "101.168.0.6/32" + ] + } } } }, @@ -149,11 +149,11 @@ "bgpPeeringAddress": "10.0.1.30", "peerWeight": 0 }, - "customRoutes": { - "addressPrefixes": [ - "101.168.0.6/32" - ] - } + "customRoutes": { + "addressPrefixes": [ + "101.168.0.6/32" + ] + } } } } diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/VirtualNetworkGatewayUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/VirtualNetworkGatewayUpdateTags.json index f7b29ef9e4db..63fbb9b6e43d 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/VirtualNetworkGatewayUpdateTags.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/VirtualNetworkGatewayUpdateTags.json @@ -55,11 +55,11 @@ "bgpPeeringAddress": "10.0.0.254", "peerWeight": 0 }, - "customRoutes": { - "addressPrefixes": [ - "101.168.0.6/32" - ] - } + "customRoutes": { + "addressPrefixes": [ + "101.168.0.6/32" + ] + } } } } diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/VirtualNetworkGatewaysListConnections.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/VirtualNetworkGatewaysListConnections.json index 7acab7c6c1ab..b71d4e530cfe 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/VirtualNetworkGatewaysListConnections.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/VirtualNetworkGatewaysListConnections.json @@ -9,7 +9,7 @@ "200": { "body": { "value": [ - { + { "name": "test-vpn-connection", "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/connections/test-vpn-connection", "etag": "W/\\\"00000000-0000-0000-0000-000000000000\\\"", diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/VirtualNetworkGetWithSubnetDelegation.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/VirtualNetworkGetWithSubnetDelegation.json index fdb54ec25dbd..fca526dcc218 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/VirtualNetworkGetWithSubnetDelegation.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/VirtualNetworkGetWithSubnetDelegation.json @@ -1,48 +1,48 @@ -{ - "parameters": { - "api-version": "2019-04-01", - "subscriptionId": "subId", - "resourceGroupName": "rg1", - "virtualNetworkName": "test-vnet" - }, - "responses": { - "200": { - "body": { - "name": "test-vnet", - "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet", - "type": "Microsoft.Network/virtualNetworks", - "location": "westus", - "properties": { - "provisioningState": "Succeeded", - "addressSpace": { - "addressPrefixes": [ - "10.0.0.0/16" - ] - }, - "subnets": [{ - "name": "subnet1", - "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1", - "properties": { - "provisioningState": "Succeeded", - "addressPrefix": "10.0.1.0/24", - "ipConfigurations": [{ - "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe" - }], - "delegations": [{ - "name": "myDelegation", - "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1/delegations/myDelegation", - "properties": { - "provisioningState": "Succeeded", - "serviceName": "Microsoft.Provider/resourceType", - "actions": [] - } - }], - "purpose": "" - } - }], - "virtualNetworkPeerings": [] - } - } - } - } +{ + "parameters": { + "api-version": "2019-04-01", + "subscriptionId": "subId", + "resourceGroupName": "rg1", + "virtualNetworkName": "test-vnet" + }, + "responses": { + "200": { + "body": { + "name": "test-vnet", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet", + "type": "Microsoft.Network/virtualNetworks", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "subnets": [{ + "name": "subnet1", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1", + "properties": { + "provisioningState": "Succeeded", + "addressPrefix": "10.0.1.0/24", + "ipConfigurations": [{ + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe" + }], + "delegations": [{ + "name": "myDelegation", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1/delegations/myDelegation", + "properties": { + "provisioningState": "Succeeded", + "serviceName": "Microsoft.Provider/resourceType", + "actions": [] + } + }], + "purpose": "" + } + }], + "virtualNetworkPeerings": [] + } + } + } + } } \ No newline at end of file diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/VirtualNetworkTapCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/VirtualNetworkTapCreate.json index 1233becedf89..efcfae8278be 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/VirtualNetworkTapCreate.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/VirtualNetworkTapCreate.json @@ -33,7 +33,7 @@ "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testNetworkInterface2/tapConfigurations/testtapConfiguration" } ] - } + } } }, "201" : { @@ -55,7 +55,7 @@ "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testNetworkInterface2/tapConfigurations/testtapConfiguration" } ] - } + } } } } diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/VirtualNetworkTapGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/VirtualNetworkTapGet.json index f8a818a550ca..b090942ccca2 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/VirtualNetworkTapGet.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/VirtualNetworkTapGet.json @@ -25,7 +25,7 @@ "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testNetworkInterface2/tapConfigurations/testtapConfiguration" } ] - } + } } } } diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/VirtualNetworkTapList.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/VirtualNetworkTapList.json index 66adc23a4d41..ac8395df2071 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/VirtualNetworkTapList.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/VirtualNetworkTapList.json @@ -26,7 +26,7 @@ "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testNetworkInterface2/tapConfigurations/testtapConfiguration" } ] - } + } }, { "name": "testvtap2", @@ -46,7 +46,7 @@ "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testNetworkInterface3/tapConfigurations/testtapConfiguration" } ] - } + } } ] } diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/VirtualNetworkTapListAll.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/VirtualNetworkTapListAll.json index 174047a16f54..a463e601e885 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/VirtualNetworkTapListAll.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/VirtualNetworkTapListAll.json @@ -25,7 +25,7 @@ "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testNetworkInterface2/tapConfigurations/testtapConfiguration" } ] - } + } }, { "name": "testvtap2", @@ -45,7 +45,7 @@ "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testNetworkInterface3/tapConfigurations/testtapConfiguration" } ] - } + } } ] } diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/VpnConnectionDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/VpnConnectionDelete.json index d0781238481f..b5e3331c4d07 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/VpnConnectionDelete.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/VpnConnectionDelete.json @@ -1,14 +1,14 @@ { - "parameters": { - "connectionName": "vpnConnection1", - "gatewayName": "gateway1", - "resourceGroupName": "rg1", - "api-version": "2019-04-01", - "subscriptionId": "subid" - }, - "responses": { - "200": { }, - "202": { }, - "204": { } - } + "parameters": { + "connectionName": "vpnConnection1", + "gatewayName": "gateway1", + "resourceGroupName": "rg1", + "api-version": "2019-04-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { }, + "202": { }, + "204": { } + } } diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/VpnConnectionGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/VpnConnectionGet.json index f046dcbd512a..e61a7327de38 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/VpnConnectionGet.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/VpnConnectionGet.json @@ -25,7 +25,7 @@ "connectionBandwidth": 100, "sharedKey": "key", "enableBgp": false, - "useLocalAzureIpAddress": false, + "useLocalAzureIpAddress": false, "ipsecPolicies": [ ] } } diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/VpnConnectionList.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/VpnConnectionList.json index e55b0097ed9e..e97ef0143811 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/VpnConnectionList.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/VpnConnectionList.json @@ -25,7 +25,7 @@ "connectionBandwidth": 100, "sharedKey": "key", "enableBgp": false, - "useLocalAzureIpAddress": false, + "useLocalAzureIpAddress": false, "ipsecPolicies": [ ] } } diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/VpnConnectionPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/VpnConnectionPut.json index 2954f89f9ad9..f528bfe39a18 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/VpnConnectionPut.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/VpnConnectionPut.json @@ -33,7 +33,7 @@ "connectionBandwidth": 100, "sharedKey": "key", "enableBgp": false, - "useLocalAzureIpAddress": false, + "useLocalAzureIpAddress": false, "ipsecPolicies": [ ] } }, @@ -54,7 +54,7 @@ "connectionBandwidth": 100, "sharedKey": "key", "enableBgp": false, - "useLocalAzureIpAddress": false, + "useLocalAzureIpAddress": false, "ipsecPolicies": [ ] } } diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/VpnGatewayDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/VpnGatewayDelete.json index 3c0b18587f88..6e64b42aca09 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/VpnGatewayDelete.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/VpnGatewayDelete.json @@ -1,13 +1,13 @@ { - "parameters": { - "gatewayName": "gateway1", - "resourceGroupName": "rg1", - "api-version": "2019-04-01", - "subscriptionId": "subid" - }, - "responses": { - "200": { }, - "202": { }, - "204": { } - } + "parameters": { + "gatewayName": "gateway1", + "resourceGroupName": "rg1", + "api-version": "2019-04-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { }, + "202": { }, + "204": { } + } } diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/VpnGatewayGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/VpnGatewayGet.json index a3270620f017..ba45c31c9f1f 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/VpnGatewayGet.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/VpnGatewayGet.json @@ -35,7 +35,7 @@ "connectionBandwidth": 100, "sharedKey": "key", "enableBgp": false, - "useLocalAzureIpAddress": false, + "useLocalAzureIpAddress": false, "ipsecPolicies": [ ] } } diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/VpnGatewayList.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/VpnGatewayList.json index 3bc5197162b3..8a862227ccb0 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/VpnGatewayList.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/VpnGatewayList.json @@ -36,7 +36,7 @@ "connectionBandwidth": 100, "sharedKey": "key", "enableBgp": false, - "useLocalAzureIpAddress": false, + "useLocalAzureIpAddress": false, "ipsecPolicies": [ ] } } @@ -76,7 +76,7 @@ "connectionBandwidth": 100, "sharedKey": "key", "enableBgp": false, - "useLocalAzureIpAddress": false, + "useLocalAzureIpAddress": false, "ipsecPolicies": [ ] } } diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/VpnGatewayListByResourceGroup.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/VpnGatewayListByResourceGroup.json index 6cc352270ce2..4a1a50be1ec9 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/VpnGatewayListByResourceGroup.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/VpnGatewayListByResourceGroup.json @@ -36,7 +36,7 @@ "connectionBandwidth": 100, "sharedKey": "key", "enableBgp": false, - "useLocalAzureIpAddress": false, + "useLocalAzureIpAddress": false, "ipsecPolicies": [ ] } } @@ -76,7 +76,7 @@ "connectionBandwidth": 100, "sharedKey": "key", "enableBgp": false, - "useLocalAzureIpAddress": false, + "useLocalAzureIpAddress": false, "ipsecPolicies": [ ] } } diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/VpnGatewayPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/VpnGatewayPut.json index 26a283736657..8c3b8c657a93 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/VpnGatewayPut.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/VpnGatewayPut.json @@ -61,7 +61,7 @@ "connectionBandwidth": 100, "sharedKey": "key", "enableBgp": false, - "useLocalAzureIpAddress": false, + "useLocalAzureIpAddress": false, "ipsecPolicies": [ ] } } @@ -101,7 +101,7 @@ "connectionBandwidth": 100, "sharedKey": "key", "enableBgp": false, - "useLocalAzureIpAddress": false, + "useLocalAzureIpAddress": false, "ipsecPolicies": [ ] } } diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/VpnSiteDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/VpnSiteDelete.json index fff44a465f9c..e633c22a5433 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/VpnSiteDelete.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/VpnSiteDelete.json @@ -1,13 +1,13 @@ { - "parameters": { - "vpnSiteName": "vpnSite1", - "resourceGroupName": "rg1", - "api-version": "2019-04-01", - "subscriptionId": "subid" - }, - "responses": { - "200": { }, - "202": { }, - "204": { } - } + "parameters": { + "vpnSiteName": "vpnSite1", + "resourceGroupName": "rg1", + "api-version": "2019-04-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { }, + "202": { }, + "204": { } + } } diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/VpnSiteGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/VpnSiteGet.json index 001c102e7599..0db2f6c42429 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/VpnSiteGet.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/VpnSiteGet.json @@ -1,41 +1,41 @@ { - "parameters": { - "vpnSiteName": "vpnSite1", - "resourceGroupName": "rg1", - "api-version": "2019-04-01", - "subscriptionId": "subid" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1", - "etag": "w/\\00000000-0000-0000-0000-000000000000\\", - "location": "West US", - "name": "vpnSite1", - "type": "Microsoft.Network/vpnSites", - "tags": { - "key1": "value1" - }, - "properties": { - "provisioningState": "Succeeded", - "virtualWan": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWANs/wan1", - "deviceProperties": { - "deviceVendor": "vendor1", - "deviceModel": "model01", - "linkSpeedInMbps": 200 - }, - "ipAddress": "10.0.0.0", - "addressSpace": { - "addressPrefixes": [ - "10.0.0.0/16" - ] - }, - "bgpProperties": { - "bgpPeeringAddress": "192.168.0.0", - "asn": 1234 - } - } - } + "parameters": { + "vpnSiteName": "vpnSite1", + "resourceGroupName": "rg1", + "api-version": "2019-04-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "vpnSite1", + "type": "Microsoft.Network/vpnSites", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "virtualWan": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWANs/wan1", + "deviceProperties": { + "deviceVendor": "vendor1", + "deviceModel": "model01", + "linkSpeedInMbps": 200 + }, + "ipAddress": "10.0.0.0", + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "bgpProperties": { + "bgpPeeringAddress": "192.168.0.0", + "asn": 1234 + } } + } } - } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/VpnSiteList.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/VpnSiteList.json index be94dbb7b068..f98044fbd871 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/VpnSiteList.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/VpnSiteList.json @@ -1,72 +1,72 @@ { - "parameters": { - "api-version": "2019-04-01", - "subscriptionId": "subid" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1", - "etag": "w/\\00000000-0000-0000-0000-000000000000\\", - "location": "West US", - "name": "vpnSite1", - "type": "Microsoft.Network/vpnSites", - "tags": { - "key1": "value1" - }, - "properties": { - "provisioningState": "Succeeded", - "virtualWan": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWANs/wan1", - "deviceProperties": { - "deviceVendor": "vendor1", - "deviceModel": "model01", - "linkSpeedInMbps": 200 - }, - "ipAddress": "10.0.0.0", - "addressSpace": { - "addressPrefixes": [ - "10.0.0.0/16" - ] - }, - "bgpProperties": { - "bgpPeeringAddress": "192.168.0.0", - "asn": 1234 - } - } - }, - { - "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/vpnSites/vpnSite2", - "etag": "w/\\00000000-0000-0000-0000-000000000000\\", - "location": "East US", - "name": "vpnSite2", - "type": "Microsoft.Network/vpnSites", - "tags": { - "key1": "value1" - }, - "properties": { - "provisioningState": "Succeeded", - "virtualWan": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualWANs/wan1", - "deviceProperties": { - "deviceVendor": "vendor1", - "deviceModel": "model01", - "linkSpeedInMbps": 200 - }, - "ipAddress": "10.1.0.0", - "addressSpace": { - "addressPrefixes": [ - "10.0.0.0/16" - ] - }, - "bgpProperties": { - "bgpPeeringAddress": "192.168.0.0", - "asn": 1234 - } - } - } + "parameters": { + "api-version": "2019-04-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "vpnSite1", + "type": "Microsoft.Network/vpnSites", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "virtualWan": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWANs/wan1", + "deviceProperties": { + "deviceVendor": "vendor1", + "deviceModel": "model01", + "linkSpeedInMbps": 200 + }, + "ipAddress": "10.0.0.0", + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" ] + }, + "bgpProperties": { + "bgpPeeringAddress": "192.168.0.0", + "asn": 1234 + } } - } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/vpnSites/vpnSite2", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "East US", + "name": "vpnSite2", + "type": "Microsoft.Network/vpnSites", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "virtualWan": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualWANs/wan1", + "deviceProperties": { + "deviceVendor": "vendor1", + "deviceModel": "model01", + "linkSpeedInMbps": 200 + }, + "ipAddress": "10.1.0.0", + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "bgpProperties": { + "bgpPeeringAddress": "192.168.0.0", + "asn": 1234 + } + } + } + ] + } } + } } diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/VpnSiteListByResourceGroup.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/VpnSiteListByResourceGroup.json index e76592a74e92..d84a5d3abd32 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/VpnSiteListByResourceGroup.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/VpnSiteListByResourceGroup.json @@ -1,73 +1,73 @@ { - "parameters": { - "api-version": "2019-04-01", - "resourceGroupName": "rg1", - "subscriptionId": "subid" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1", - "etag": "w/\\00000000-0000-0000-0000-000000000000\\", - "location": "West US", - "name": "vpnSite1", - "type": "Microsoft.Network/vpnSites", - "tags": { - "key1": "value1" - }, - "properties": { - "provisioningState": "Succeeded", - "virtualWan": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWANs/wan1", - "deviceProperties": { - "deviceVendor": "vendor1", - "deviceModel": "model01", - "linkSpeedInMbps": 200 - }, - "ipAddress": "10.0.0.0", - "addressSpace": { - "addressPrefixes": [ - "10.0.0.0/16" - ] - }, - "bgpProperties": { - "bgpPeeringAddress": "192.168.0.0", - "asn": 1234 - } - } - }, - { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite2", - "etag": "w/\\00000000-0000-0000-0000-000000000000\\", - "location": "West US", - "name": "vpnSite2", - "type": "Microsoft.Network/vpnSites", - "tags": { - "key1": "value1" - }, - "properties": { - "provisioningState": "Succeeded", - "virtualWan": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWANs/wan1", - "deviceProperties": { - "deviceVendor": "vendor1", - "deviceModel": "model01", - "linkSpeedInMbps": 200 - }, - "ipAddress": "10.1.0.0", - "addressSpace": { - "addressPrefixes": [ - "10.0.0.0/16" - ] - }, - "bgpProperties": { - "bgpPeeringAddress": "192.168.0.0", - "asn": 1234 - } - } - } + "parameters": { + "api-version": "2019-04-01", + "resourceGroupName": "rg1", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "vpnSite1", + "type": "Microsoft.Network/vpnSites", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "virtualWan": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWANs/wan1", + "deviceProperties": { + "deviceVendor": "vendor1", + "deviceModel": "model01", + "linkSpeedInMbps": 200 + }, + "ipAddress": "10.0.0.0", + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" ] + }, + "bgpProperties": { + "bgpPeeringAddress": "192.168.0.0", + "asn": 1234 + } } - } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite2", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "vpnSite2", + "type": "Microsoft.Network/vpnSites", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "virtualWan": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWANs/wan1", + "deviceProperties": { + "deviceVendor": "vendor1", + "deviceModel": "model01", + "linkSpeedInMbps": 200 + }, + "ipAddress": "10.1.0.0", + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "bgpProperties": { + "bgpPeeringAddress": "192.168.0.0", + "asn": 1234 + } + } + } + ] + } } + } } diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/VpnSitePut.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/VpnSitePut.json index 1e723411f498..62a53e181a79 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/VpnSitePut.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/VpnSitePut.json @@ -1,96 +1,96 @@ { - "parameters": { - "vpnSiteName": "vpnSite1", - "resourceGroupName": "rg1", - "api-version": "2019-04-01", - "subscriptionId": "subid", - "VpnSiteParameters": { - "tags": { - "key1": "value1" - }, - "location": "West US", - "properties": { - "virtualWan": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/VirtualWans/virtualWan1", - "deviceProperties": { - "deviceVendor": "vendor1", - "deviceModel": "model01", - "linkSpeedInMbps": 200 - }, - "ipAddress": "10.0.0.0", - "addressSpace": { - "addressPrefixes": [ - "10.0.0.0/16" - ] - }, - "bgpProperties": { - "bgpPeeringAddress": "192.168.0.0", - "asn": 1234 - } - } + "parameters": { + "vpnSiteName": "vpnSite1", + "resourceGroupName": "rg1", + "api-version": "2019-04-01", + "subscriptionId": "subid", + "VpnSiteParameters": { + "tags": { + "key1": "value1" + }, + "location": "West US", + "properties": { + "virtualWan": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/VirtualWans/virtualWan1", + "deviceProperties": { + "deviceVendor": "vendor1", + "deviceModel": "model01", + "linkSpeedInMbps": 200 + }, + "ipAddress": "10.0.0.0", + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "bgpProperties": { + "bgpPeeringAddress": "192.168.0.0", + "asn": 1234 + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "vpnSite1", + "type": "Microsoft.Network/vpnSites", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "virtualWan": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/VirtualWans/virtualWan1", + "deviceProperties": { + "deviceVendor": "vendor1", + "deviceModel": "model01", + "linkSpeedInMbps": 200 + }, + "ipAddress": "10.1.0.0", + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "bgpProperties": { + "bgpPeeringAddress": "192.168.0.0", + "asn": 1234 + } } + } }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1", - "etag": "w/\\00000000-0000-0000-0000-000000000000\\", - "location": "West US", - "name": "vpnSite1", - "type": "Microsoft.Network/vpnSites", - "tags": { - "key1": "value1" - }, - "properties": { - "provisioningState": "Succeeded", - "virtualWan": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/VirtualWans/virtualWan1", - "deviceProperties": { - "deviceVendor": "vendor1", - "deviceModel": "model01", - "linkSpeedInMbps": 200 - }, - "ipAddress": "10.1.0.0", - "addressSpace": { - "addressPrefixes": [ - "10.0.0.0/16" - ] - }, - "bgpProperties": { - "bgpPeeringAddress": "192.168.0.0", - "asn": 1234 - } - } - } + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "vpnSite1", + "type": "Microsoft.Network/vpnSites", + "tags": { + "key1": "value1" }, - "201": { - "body": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1", - "etag": "w/\\00000000-0000-0000-0000-000000000000\\", - "location": "West US", - "name": "vpnSite1", - "type": "Microsoft.Network/vpnSites", - "tags": { - "key1": "value1" - }, - "properties": { - "provisioningState": "Succeeded", - "virtualWan": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/VirtualWans/virtualWan1", - "deviceProperties": { - "deviceVendor": "vendor1", - "deviceModel": "model01", - "linkSpeedInMbps": 200 - }, - "ipAddress": "10.1.0.0", - "addressSpace": { - "addressPrefixes": [ - "10.0.0.0/16" - ] - }, - "bgpProperties": { - "bgpPeeringAddress": "192.168.0.0", - "asn": 1234 - } - } - } + "properties": { + "provisioningState": "Succeeded", + "virtualWan": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/VirtualWans/virtualWan1", + "deviceProperties": { + "deviceVendor": "vendor1", + "deviceModel": "model01", + "linkSpeedInMbps": 200 + }, + "ipAddress": "10.1.0.0", + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "bgpProperties": { + "bgpPeeringAddress": "192.168.0.0", + "asn": 1234 + } } + } } + } } diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/interfaceEndpoint.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/interfaceEndpoint.json index e835ffe48a6e..638236cb9b50 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/interfaceEndpoint.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/interfaceEndpoint.json @@ -1,344 +1,344 @@ -{ - "swagger": "2.0", - "info": { - "title": "NetworkManagementClient", - "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", - "version": "2019-04-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}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/interfaceEndpoints/{interfaceEndpointName}": { - "delete": { - "tags": [ - "InterfaceEndpoints" - ], - "operationId": "InterfaceEndpoints_Delete", - "description": "Deletes the specified interface endpoint.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." - }, - { - "name": "interfaceEndpointName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the interface endpoint." - }, - { - "$ref": "./network.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "./network.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "202": { - "description": "Accepted and the operation will complete asynchronously." - }, - "204": { - "description": "Delete successful." - }, - "200": { - "description": "Delete successful." - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" - }, - "x-ms-examples": { - "Delete interface endpoint": { "$ref": "./examples/InterfaceEndpointDelete.json" } - } - }, - "get": { - "tags": [ - "InterfaceEndpoints" - ], - "operationId": "InterfaceEndpoints_Get", - "description": "Gets the specified interface endpoint by resource group.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." - }, - { - "name": "interfaceEndpointName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the interface endpoint." - }, - { - "$ref": "./network.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "./network.json#/parameters/SubscriptionIdParameter" - }, - { - "name": "$expand", - "in": "query", - "required": false, - "type": "string", - "description": "Expands referenced resources." - } - ], - "responses": { - "200": { - "description": "Request successful. The operation returns the resulting InterfaceEndpoint resource.", - "schema": { - "$ref": "#/definitions/InterfaceEndpoint" - } - } - }, - "x-ms-examples": { - "Get interface endpoint": { "$ref": "./examples/InterfaceEndpointGet.json" } - } - }, - "put": { - "tags": [ - "InterfaceEndpoints" - ], - "operationId": "InterfaceEndpoints_CreateOrUpdate", - "description": "Creates or updates an interface endpoint in the specified resource group.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." - }, - { - "name": "interfaceEndpointName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the interface endpoint." - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/InterfaceEndpoint" - }, - "description": "Parameters supplied to the create or update interface endpoint operation" - }, - { - "$ref": "./network.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "./network.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Update successful. The operation returns the resulting InterfaceEndpoint resource.", - "schema": { - "$ref": "#/definitions/InterfaceEndpoint" - } - }, - "201": { - "description": "Create successful. The operation returns the resulting InterfaceEndpoint resource.", - "schema": { - "$ref": "#/definitions/InterfaceEndpoint" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "azure-async-operation" - }, - "x-ms-examples": { - "Create interface endpoint": { "$ref": "./examples/InterfaceEndpointCreate.json" } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/interfaceEndpoints": { - "get": { - "tags": [ - "InterfaceEndpoints" - ], - "operationId": "InterfaceEndpoints_List", - "description": "Gets all interface endpoints in a resource group.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." - }, - { - "$ref": "./network.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "./network.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Request successful. The operation returns a list of InterfaceEndpoint resources.", - "schema": { - "$ref": "#/definitions/InterfaceEndpointListResult" - } - } - }, - "x-ms-examples": { - "List interface endpoints in resource group": { "$ref": "./examples/InterfaceEndpointList.json" } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Network/interfaceEndpoints": { - "get": { - "tags": [ - "InterfaceEndpoints" - ], - "operationId": "InterfaceEndpoints_ListBySubscription", - "description": "Gets all interface endpoints in a subscription.", - "parameters": [ - { - "$ref": "./network.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "./network.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Request successful. The operation returns a list of InterfaceEndpoint resources.", - "schema": { - "$ref": "#/definitions/InterfaceEndpointListResult" - } - } - }, - "x-ms-examples": { - "List all interface endpoints": { "$ref": "./examples/InterfaceEndpointListAll.json" } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - } - }, - "definitions": { - "InterfaceEndpoint": { - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/InterfaceEndpointProperties", - "description": "Properties of the interface endpoint." - }, - "etag": { - "type": "string", - "description": "Gets a unique read-only string that changes whenever the resource is updated." - } - }, - "allOf": [ - { - "$ref": "./network.json#/definitions/Resource" - } - ], - "description": "Interface endpoint resource." - }, - "InterfaceEndpointProperties": { - "properties": { - "fqdn": { - "type": "string", - "description": "A first-party service's FQDN that is mapped to the private IP allocated via this interface endpoint." - }, - "endpointService": { - "$ref": "#/definitions/EndpointService", - "description": "A reference to the service being brought into the virtual network." - }, - "subnet": { - "$ref": "./virtualNetwork.json#/definitions/Subnet", - "description": "The ID of the subnet from which the private IP will be allocated." - }, - "networkInterfaces": { - "type": "array", - "readOnly": true, - "items": { - "$ref": "./networkInterface.json#/definitions/NetworkInterface" - }, - "description": "Gets an array of references to the network interfaces created for this interface endpoint." - }, - "owner": { - "type": "string", - "readOnly": true, - "description": "A read-only property that identifies who created this interface endpoint." - }, - "provisioningState": { - "readOnly": true, - "type": "string", - "description": "The provisioning state of the interface endpoint. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Properties of the interface endpoint." - }, - "EndpointService": { - "properties": { - "id": { - "type": "string", - "description": "A unique identifier of the service being referenced by the interface endpoint." - } - }, - "description": "Identifies the service being brought into the virtual network." - }, - "InterfaceEndpointListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/InterfaceEndpoint" - }, - "description": "Gets a list of InterfaceEndpoint resources in a resource group." - }, - "nextLink": { - "type": "string", - "description": "The URL to get the next set of results.", - "readOnly": true - } - }, - "description": "Response for the ListInterfaceEndpoints API service call." - } - } -} +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2019-04-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}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/interfaceEndpoints/{interfaceEndpointName}": { + "delete": { + "tags": [ + "InterfaceEndpoints" + ], + "operationId": "InterfaceEndpoints_Delete", + "description": "Deletes the specified interface endpoint.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "interfaceEndpointName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the interface endpoint." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "204": { + "description": "Delete successful." + }, + "200": { + "description": "Delete successful." + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Delete interface endpoint": { "$ref": "./examples/InterfaceEndpointDelete.json" } + } + }, + "get": { + "tags": [ + "InterfaceEndpoints" + ], + "operationId": "InterfaceEndpoints_Get", + "description": "Gets the specified interface endpoint by resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "interfaceEndpointName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the interface endpoint." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "Expands referenced resources." + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting InterfaceEndpoint resource.", + "schema": { + "$ref": "#/definitions/InterfaceEndpoint" + } + } + }, + "x-ms-examples": { + "Get interface endpoint": { "$ref": "./examples/InterfaceEndpointGet.json" } + } + }, + "put": { + "tags": [ + "InterfaceEndpoints" + ], + "operationId": "InterfaceEndpoints_CreateOrUpdate", + "description": "Creates or updates an interface endpoint in the specified resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "interfaceEndpointName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the interface endpoint." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/InterfaceEndpoint" + }, + "description": "Parameters supplied to the create or update interface endpoint operation" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting InterfaceEndpoint resource.", + "schema": { + "$ref": "#/definitions/InterfaceEndpoint" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting InterfaceEndpoint resource.", + "schema": { + "$ref": "#/definitions/InterfaceEndpoint" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Create interface endpoint": { "$ref": "./examples/InterfaceEndpointCreate.json" } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/interfaceEndpoints": { + "get": { + "tags": [ + "InterfaceEndpoints" + ], + "operationId": "InterfaceEndpoints_List", + "description": "Gets all interface endpoints in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of InterfaceEndpoint resources.", + "schema": { + "$ref": "#/definitions/InterfaceEndpointListResult" + } + } + }, + "x-ms-examples": { + "List interface endpoints in resource group": { "$ref": "./examples/InterfaceEndpointList.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/interfaceEndpoints": { + "get": { + "tags": [ + "InterfaceEndpoints" + ], + "operationId": "InterfaceEndpoints_ListBySubscription", + "description": "Gets all interface endpoints in a subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of InterfaceEndpoint resources.", + "schema": { + "$ref": "#/definitions/InterfaceEndpointListResult" + } + } + }, + "x-ms-examples": { + "List all interface endpoints": { "$ref": "./examples/InterfaceEndpointListAll.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "InterfaceEndpoint": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/InterfaceEndpointProperties", + "description": "Properties of the interface endpoint." + }, + "etag": { + "type": "string", + "description": "Gets a unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "Interface endpoint resource." + }, + "InterfaceEndpointProperties": { + "properties": { + "fqdn": { + "type": "string", + "description": "A first-party service's FQDN that is mapped to the private IP allocated via this interface endpoint." + }, + "endpointService": { + "$ref": "#/definitions/EndpointService", + "description": "A reference to the service being brought into the virtual network." + }, + "subnet": { + "$ref": "./virtualNetwork.json#/definitions/Subnet", + "description": "The ID of the subnet from which the private IP will be allocated." + }, + "networkInterfaces": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "./networkInterface.json#/definitions/NetworkInterface" + }, + "description": "Gets an array of references to the network interfaces created for this interface endpoint." + }, + "owner": { + "type": "string", + "readOnly": true, + "description": "A read-only property that identifies who created this interface endpoint." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state of the interface endpoint. Possible values are: 'Updating', 'Deleting', and 'Failed'." + } + }, + "description": "Properties of the interface endpoint." + }, + "EndpointService": { + "properties": { + "id": { + "type": "string", + "description": "A unique identifier of the service being referenced by the interface endpoint." + } + }, + "description": "Identifies the service being brought into the virtual network." + }, + "InterfaceEndpointListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/InterfaceEndpoint" + }, + "description": "Gets a list of InterfaceEndpoint resources in a resource group." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results.", + "readOnly": true + } + }, + "description": "Response for the ListInterfaceEndpoints API service call." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/natGateway.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/natGateway.json index a10998858b66..c12382888b42 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/natGateway.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/natGateway.json @@ -351,7 +351,7 @@ "$ref": "./network.json#/definitions/SubResource" }, "description": "An array of public ip prefixes associated with the nat gateway resource." - }, + }, "subnets": { "readOnly": true, "type": "array", diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/usage.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/usage.json index f2355a841c40..32cbbe6f8300 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/usage.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/usage.json @@ -48,7 +48,7 @@ "required": true, "type": "string", "description": "The location where resource usage is queried.", - "pattern": "^[-\\w\\._ ]+$" + "pattern": "^[-\\w\\._ ]+$" }, { "$ref": "./network.json#/parameters/ApiVersionParameter" @@ -66,8 +66,8 @@ } }, "x-ms-examples": { - "List usages": { "$ref": "./examples/UsageList.json" }, - "List usages spaced location": { "$ref": "./examples/UsageListSpacedLocation.json" } + "List usages": { "$ref": "./examples/UsageList.json" }, + "List usages spaced location": { "$ref": "./examples/UsageListSpacedLocation.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/virtualNetworkGateway.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/virtualNetworkGateway.json index 340f65f39c5c..cb53006b3cd4 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/virtualNetworkGateway.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/virtualNetworkGateway.json @@ -1680,7 +1680,7 @@ "customRoutes": { "$ref": "./virtualNetwork.json#/definitions/AddressSpace", "description": "The reference of the address space resource which represents the custom routes address space specified by the the customer for virtual network gateway and VpnClient." - }, + }, "resourceGuid": { "type": "string", "description": "The resource GUID property of the VirtualNetworkGateway resource." diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/virtualWan.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/virtualWan.json index 91fb6969f9a9..868b87d639ec 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/virtualWan.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/virtualWan.json @@ -2723,7 +2723,7 @@ "type": "boolean", "description": "Enable internet security" }, - "useLocalAzureIpAddress": { + "useLocalAzureIpAddress": { "type": "boolean", "description": "Use local azure ip to initiate connection" }, @@ -3309,7 +3309,7 @@ "customRoutes": { "$ref": "./virtualNetwork.json#/definitions/AddressSpace", "description": "The reference of the address space resource which represents the custom routes specified by the customer for P2SVpnGateway and P2S VpnClient." - }, + }, "vpnClientConnectionHealth": { "readOnly": true, "$ref": "#/definitions/VpnClientConnectionHealth", diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/webapplicationfirewall.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/webapplicationfirewall.json index a2e4d1c2de33..04ce53640fe5 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/webapplicationfirewall.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/webapplicationfirewall.json @@ -106,7 +106,7 @@ "nextLinkName": "nextLink" } } - }, + }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies/{policyName}": { "get": { "tags": [ diff --git a/specification/network/resource-manager/readme.csharp.md b/specification/network/resource-manager/readme.csharp.md index c38e7f7352a5..078b6d02c492 100644 --- a/specification/network/resource-manager/readme.csharp.md +++ b/specification/network/resource-manager/readme.csharp.md @@ -37,14 +37,21 @@ batch: ApiVersionName: Api2016_06_15 ``` +### Profile: hybrid_2018_03_01 + +These settings apply only when `--profile=hybrid_2018_03_01` is specified on the command line. + ```yaml $(profile)=='hybrid_2018_03_01' namespace: Microsoft.Azure.Management.Profiles.$(profile).Network output-folder: $(csharp-sdks-folder)/$(profile)/Network/Management.Network/Generated batch: - - tag: package-2018-05 - tag: package-2017-10 ``` +### Profile: profile_2017_03_09 + +These settings apply only when `--profile=profile_2017_03_09` is specified on the command line. + ``` yaml $(profile)=='profile_2017_03_09' namespace: Microsoft.Azure.Management.Profiles.$(profile).Network output-folder: $(csharp-sdks-folder)/$(profile)/Network/Management.Network/Generated diff --git a/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/preview/2015-11-01-preview/OperationalInsights.json b/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/preview/2015-11-01-preview/OperationalInsights.json index 4d92d3ca149c..cdf16680bba9 100644 --- a/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/preview/2015-11-01-preview/OperationalInsights.json +++ b/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/preview/2015-11-01-preview/OperationalInsights.json @@ -1272,7 +1272,6 @@ "Free", "Standard", "Premium", - "Unlimited", "PerNode", "PerGB2018", "Standalone" diff --git a/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/preview/2018-09-01-preview/examples/GraphQueryAdd.json b/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/preview/2018-09-01-preview/examples/GraphQueryAdd.json new file mode 100644 index 000000000000..2f61c242e3ae --- /dev/null +++ b/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/preview/2018-09-01-preview/examples/GraphQueryAdd.json @@ -0,0 +1,34 @@ +{ + "title": "Create a saved query", + "description": "Create new saved query resource.", + "parameters": { + "subscriptionId": "024e2271-06fa-46b6-9079-f1ed3c7b070e", + "resourceGroupName": "my-resource-group", + "resourceName": "MyDockerVMs", + "api-version": "2018-09-01-preview", + "properties": { + "tags": {}, + "properties": { + "description": "Docker VMs in PROD", + "query": "where isnotnull(tags['Prod']) and properties.extensions[0].Name == 'docker'" + } + } + }, + "responses": { + "200": { + "body": { + "id": " /subscriptions/024e2271-06fa-46b6-9079-f1ed3c7b070e/resources/my-resource-group/providers/Microsoft.ResourceGraph/queries/MyDockerVMs", + "name": "MyDockerVMs", + "type": "Microsoft.ResourceGraph/queries", + "eTag": "5d64408e-4ca3-41f7-b725-6914f3012afa", + "tags": {}, + "properties": { + "description": "Docker VMs in PROD", + "query": "where isnotnull(tags['Prod']) and properties.extensions[0].Name == 'docker'", + "resultKind": "basic", + "timeModified": "2019-03-12T13:51:13-07:00" + } + } + } + } +} \ No newline at end of file diff --git a/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/preview/2018-09-01-preview/examples/GraphQueryDelete.json b/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/preview/2018-09-01-preview/examples/GraphQueryDelete.json new file mode 100644 index 000000000000..1288229841cf --- /dev/null +++ b/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/preview/2018-09-01-preview/examples/GraphQueryDelete.json @@ -0,0 +1,14 @@ +{ + "title": "Delete a saved query", + "description": "Delete a saved query resource by subid, resource group, and resource name.", + "parameters": { + "subscriptionId": "024e2271-06fa-46b6-9079-f1ed3c7b070e", + "resourceGroupName": "my-resource-group", + "resourceName": "MyDockerVM", + "api-version": "2018-09-01-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} \ No newline at end of file diff --git a/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/preview/2018-09-01-preview/examples/GraphQueryGet.json b/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/preview/2018-09-01-preview/examples/GraphQueryGet.json new file mode 100644 index 000000000000..c9fc0f4bb736 --- /dev/null +++ b/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/preview/2018-09-01-preview/examples/GraphQueryGet.json @@ -0,0 +1,27 @@ +{ + "title": "Get a saved query", + "description": "Get a saved query resource by subid, resource group, and resource name.", + "parameters": { + "subscriptionId": "024e2271-06fa-46b6-9079-f1ed3c7b070e", + "resourceGroupName": "my-resource-group", + "resourceName": "MyDockerVMs", + "api-version": "2018-09-01-preview" + }, + "responses": { + "200": { + "body": { + "id": " /subscriptions/024e2271-06fa-46b6-9079-f1ed3c7b070e/resources/my-resource-group/providers/Microsoft.ResourceGraph/queries/MyDockerVMs", + "name": "MyDockerVMs", + "type": "Microsoft.ResourceGraph/queries", + "eTag": "5d64408e-4ca3-41f7-b725-6914f3012afa", + "tags": null, + "properties": { + "description": "Docker VMs in PROD", + "query": "where isnotnull(tags['Prod']) and properties.extensions[0].Name == 'docker'", + "resultKind": "basic", + "timeModified": "2019-03-12T13:51:13-07:00" + } + } + } + } +} \ No newline at end of file diff --git a/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/preview/2018-09-01-preview/examples/GraphQueryList.json b/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/preview/2018-09-01-preview/examples/GraphQueryList.json new file mode 100644 index 000000000000..7e5316caa4c8 --- /dev/null +++ b/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/preview/2018-09-01-preview/examples/GraphQueryList.json @@ -0,0 +1,44 @@ +{ + "title": "Get a list of saved queries", + "description": "Get a list of saved queries within subscription id and resource group.", + "parameters": { + "subscriptionId": "024e2271-06fa-46b6-9079-f1ed3c7b070e", + "resourceGroupName": "my-resource-group", + "api-version": "2018-09-01-preview" + }, + "responses": { + "200": { + "body": { + "nextLink": "https://management.azure.com/subscriptions/subscriptionId/providers/Microsoft.ResourceGraph/queries?api-version=2019-09-01-preview&$top=10&$skiptoken=skiptoken", + "value": [ + { + "id": "/subscriptions/87f4f8b0-83c1-4aa9-b318-5237aeb15264/resources/rid1/providers/Microsoft.ResourceGraph/queries/MyDockerVMs", + "name": "MyDockerVMs", + "type": "Microsoft.ResourceGraph/queries", + "tags": {}, + "eTag": "5d64408e-4ca3-41f7-b725-6914f3012afa", + "properties": { + "description": "Docker VMs in PROD", + "query": "where isnotnull(tags['Prod']) and properties.extensions[0].Name == 'docker'", + "resultKind": "basic", + "timeModified": "2019-03-12T13:51:13-07:00" + } + }, + { + "id": "/subscriptions/6abb2f31-3e6a-4134-9968-219a596012a0/resources/rid2/providers/Microsoft.ResourceGraph/queries/MyTestVMs", + "name": "MyTestVMs", + "type": "Microsoft.ResourceGraph/queries", + "tags": {}, + "eTag": "b0809832-ca62-4133-8f13-0c46580f9db1", + "properties": { + "description": "Test VMs in PROD", + "query": "where isnotnull(tags['Prod']) and properties.extensions[0].Name == 'test'", + "resultKind": "basic", + "timeModified": "2019-03-13T13:51:13-07:00" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/preview/2018-09-01-preview/examples/GraphQueryUpdate.json b/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/preview/2018-09-01-preview/examples/GraphQueryUpdate.json new file mode 100644 index 000000000000..c7a0b88d640f --- /dev/null +++ b/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/preview/2018-09-01-preview/examples/GraphQueryUpdate.json @@ -0,0 +1,35 @@ +{ + "title": "Update a saved query", + "description": "Update the existing saved query resource.", + "parameters": { + "subscriptionId": "024e2271-06fa-46b6-9079-f1ed3c7b070e", + "resourceGroupName": "my-resource-group", + "resourceName": "MyDockerVMs", + "api-version": "2018-09-01-preview", + "body": { + "tags": null, + "eTag": "b0809832-ca62-4133-8f13-0c46580f9db1", + "properties": { + "description": "Modified description", + "query": "where isnotnull(tags['Prod']) and properties.extensions[0].Name == 'docker'" + } + } + }, + "responses": { + "200": { + "body": { + "id": " /subscriptions/024e2271-06fa-46b6-9079-f1ed3c7b070e/resources/my-resource-group/providers/Microsoft.ResourceGraph/queries/MyDockerVMs", + "name": "MyDockerVMs", + "type": "Microsoft.ResourceGraph/queries", + "eTag": "73811091-6188-4523-97b7-b5e7134e7fd9", + "tags": null, + "properties": { + "description": "Modified description", + "query": "where isnotnull(tags['Prod']) and properties.extensions[0].Name == 'docker'", + "resultKind": "basic", + "timeModified": "2019-03-14T13:51:13-07:00" + } + } + } + } +} \ No newline at end of file diff --git a/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/preview/2018-09-01-preview/examples/OperationsList.json b/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/preview/2018-09-01-preview/examples/OperationsList.json index 8e2165b092e8..5944d80fcfc5 100644 --- a/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/preview/2018-09-01-preview/examples/OperationsList.json +++ b/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/preview/2018-09-01-preview/examples/OperationsList.json @@ -14,6 +14,15 @@ "operation": "Query resources", "description": "Submits a query on resources within specified subscriptions" } + }, + { + "name": "Microsoft.ResourceGraph/queries/action", + "display": { + "provider": "Microsoft Resource Graph", + "resource": "Queries", + "operation": "CRUD operations of graph queries", + "description": "Create/Update/Retrieve a query within specified subscription and resource group." + } } ] } diff --git a/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/preview/2018-09-01-preview/examples/ResourceChangesFirstPage.json b/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/preview/2018-09-01-preview/examples/ResourceChangesFirstPage.json index 045368463744..46a32929e680 100644 --- a/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/preview/2018-09-01-preview/examples/ResourceChangesFirstPage.json +++ b/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/preview/2018-09-01-preview/examples/ResourceChangesFirstPage.json @@ -9,7 +9,7 @@ "start": "2018-10-30T12:09:03.141Z", "end": "2018-10-31T12:09:03.141Z" }, - "$top": "2" + "$top": 2 } }, "responses": { diff --git a/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/preview/2018-09-01-preview/examples/ResourceChangesNextPage.json b/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/preview/2018-09-01-preview/examples/ResourceChangesNextPage.json index efbd570e98e0..9137145ef488 100644 --- a/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/preview/2018-09-01-preview/examples/ResourceChangesNextPage.json +++ b/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/preview/2018-09-01-preview/examples/ResourceChangesNextPage.json @@ -9,7 +9,7 @@ "start": "2018-10-30T12:09:03.141Z", "end": "2018-10-31T12:09:03.141Z" }, - "$top": "2", + "$top": 2, "$skipToken": "ew0KICAiJGlkIjogIjEiLA0KICAiRW5kVGltZSI6ICJcL0RhdGUoMTU1MDc0NT" } }, diff --git a/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/preview/2018-09-01-preview/graphquery.json b/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/preview/2018-09-01-preview/graphquery.json new file mode 100644 index 000000000000..bc26c8e4b273 --- /dev/null +++ b/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/preview/2018-09-01-preview/graphquery.json @@ -0,0 +1,493 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Resource Graph Query", + "description": "Azure Resource Graph Query API Reference", + "version": "2018-09-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}/resourceGroup/{resourceGroupName}/providers/Microsoft.ResourceGraph/queries": { + "get": { + "description": "Get all graph queries defined within a specified subscription and resource group.", + "operationId": "GraphQuery_List", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "A list containing 0 or more graph queries.", + "schema": { + "$ref": "#/definitions/GraphQueryListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/GraphQueryError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Get a list of Graph Queries": { + "$ref": "./examples/GraphQueryList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroup/{resourceGroupName}/providers/Microsoft.ResourceGraph/queries/{resourceName}": { + "get": { + "description": "Get a single graph query by its resourceName.", + "operationId": "GraphQuery_Get", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/GraphQueryResourceNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "A graph query definition.", + "schema": { + "$ref": "#/definitions/GraphQueryResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/GraphQueryError" + } + } + }, + "x-ms-examples": { + "Get Graph Query": { + "$ref": "./examples/GraphQueryGet.json" + } + } + }, + "delete": { + "description": "Delete a graph query.", + "operationId": "GraphQuery_Delete", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/GraphQueryResourceNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The graph query has been successfully deleted." + }, + "204": { + "description": "The resource doesn't exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/GraphQueryError" + } + } + }, + "x-ms-examples": { + "Delete Graph Query": { + "$ref": "./examples/GraphQueryDelete.json" + } + } + }, + "put": { + "description": "Create a new graph query.", + "operationId": "GraphQuery_CreateOrUpdate", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/GraphQueryResourceNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "properties", + "description": "Properties that need to be specified to create a new graph query.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/GraphQueryResource" + } + } + ], + "responses": { + "200": { + "description": "The newly created graph query.", + "schema": { + "$ref": "#/definitions/GraphQueryResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/GraphQueryError" + } + } + }, + "x-ms-examples": { + "Create Graph Query": { + "$ref": "./examples/GraphQueryAdd.json" + } + } + }, + "patch": { + "description": "Updates a graph query that has already been added.", + "operationId": "GraphQuery_Update", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/GraphQueryResourceNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "body", + "description": "Properties that need to be specified to create a new graph query.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/GraphQueryUpdateParameters" + } + } + ], + "responses": { + "200": { + "description": "The graph query definition updated.", + "schema": { + "$ref": "#/definitions/GraphQueryResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/GraphQueryError" + } + } + }, + "x-ms-examples": { + "Update Graph Query": { + "$ref": "./examples/GraphQueryUpdate.json" + } + } + } + }, + "/providers/Microsoft.ResourceGraph/operations": { + "get": { + "tags": [ + "Operations" + ], + "description": "Lists all of the available REST API operations.", + "operationId": "Operations_List", + "x-ms-examples": { + "OperationsList": { + "$ref": "./examples/OperationsList.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "resourcegraph.json#/definitions/OperationListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "Resource": { + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "Azure resource Id" + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Azure resource name. This is GUID value. The display name should be assigned within properties field." + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Azure resource type" + }, + "eTag": { + "type": "string", + "readOnly": true, + "description": "This will be used to handle Optimistic Concurrency. If not present, it will always overwrite the existing resource without checking conflict." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + } + }, + "x-ms-azure-resource": true, + "description": "An azure resource object" + }, + "GraphQueryListResult": { + "properties": { + "nextLink": { + "description": "URL to fetch the next set of queries.", + "type": "string" + }, + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/GraphQueryResource" + }, + "description": "An array of graph queries." + } + }, + "description": "Graph query list result." + }, + "GraphQueryResource": { + "description": "Graph Query entity definition.", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Metadata describing a graph query for an Azure resource.", + "$ref": "#/definitions/GraphQueryProperties" + } + } + }, + "GraphQueryProperties": { + "description": "Properties that contain a graph query.", + "required": [ + "query" + ], + "properties": { + "timeModified": { + "type": "string", + "description": "Date and time in UTC of the last modification that was made to this graph query definition.", + "format": "date-time", + "readOnly": true + }, + "description": { + "type": "string", + "description": "The description of a graph query." + }, + "query": { + "type": "string", + "description": "KQL query that will be graph." + }, + "resultKind": { + "description": "Enum indicating a type of graph query.", + "readOnly": true, + "default": "basic", + "type": "string", + "enum": [ + "basic" + ], + "x-ms-enum": { + "name": "ResultKind", + "modelAsString": true + } + } + } + }, + "GraphQueryUpdateParameters": { + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + }, + "eTag": { + "type": "string", + "readOnly": true, + "description": "This will be used to handle Optimistic Concurrency. If not present, it will always overwrite the existing resource without checking conflict." + }, + "properties": { + "x-ms-client-flatten": true, + "description": "Metadata describing a graph query for an Azure resource.", + "$ref": "#/definitions/GraphQueryPropertiesUpdateParameters" + } + }, + "description": "The parameters that can be provided when updating workbook properties properties." + }, + "GraphQueryPropertiesUpdateParameters": { + "description": "Properties that contain a workbook for PATCH operation.", + "properties": { + "description": { + "type": "string", + "description": "The description of a graph query." + }, + "query": { + "type": "string", + "description": "KQL query that will be graph." + }, + "resultKind": { + "description": "Enum indicating a type of graph query.", + "default": "basic", + "type": "string", + "enum": [ + "basic" + ], + "x-ms-enum": { + "name": "ResultKind", + "modelAsString": true + } + } + } + }, + "ErrorFieldContract": { + "properties": { + "code": { + "type": "string", + "description": "Property level error code." + }, + "message": { + "type": "string", + "description": "Human-readable representation of property-level error." + }, + "target": { + "type": "string", + "description": "Property name." + } + }, + "description": "Error Field contract." + }, + "GraphQueryError": { + "properties": { + "code": { + "type": "string", + "description": "Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response." + }, + "message": { + "type": "string", + "description": "Human-readable representation of the error." + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/ErrorFieldContract" + }, + "description": "The list of invalid fields send in request, in case of validation error." + } + }, + "description": "Error message body that will indicate why the operation failed." + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The Azure subscription Id." + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client Api Version." + }, + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group.", + "x-ms-parameter-location": "method" + }, + "GraphQueryResourceNameParameter": { + "name": "resourceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Graph Query resource.", + "x-ms-parameter-location": "method" + } + } +} \ No newline at end of file diff --git a/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/preview/2018-09-01-preview/resourcegraph.json b/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/preview/2018-09-01-preview/resourcegraph.json index fb66706f7ce3..50600b2a8cd8 100644 --- a/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/preview/2018-09-01-preview/resourcegraph.json +++ b/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/preview/2018-09-01-preview/resourcegraph.json @@ -27,7 +27,7 @@ "type": "oauth2", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "flow": "implicit", - "description": "Azure Active Directory OAuth2 Flow", + "description": "Azure Active Directory OAuth2 Flow.", "scopes": { "user_impersonation": "impersonate your user account" } @@ -196,7 +196,7 @@ } }, "x-ms-pageable": { - "nextLinkName": null + "nextLinkName": "nextLink" } } } @@ -701,6 +701,10 @@ "$ref": "#/definitions/Operation" }, "description": "List of Resource Graph operations supported by the Resource Graph resource provider." + }, + "nextLink": { + "description": "The link used to get the next page of results.", + "type": "string" } } }, @@ -745,7 +749,7 @@ "in": "query", "required": true, "type": "string", - "description": "API version." + "description": "Client Api Version." } } -} +} \ No newline at end of file diff --git a/specification/resourcegraph/resource-manager/readme.go.md b/specification/resourcegraph/resource-manager/readme.go.md index 484e2e980fe7..9c93699bc8af 100644 --- a/specification/resourcegraph/resource-manager/readme.go.md +++ b/specification/resourcegraph/resource-manager/readme.go.md @@ -14,6 +14,7 @@ go: ``` yaml $(go) && $(multiapi) batch: - tag: package-2019-04 + - tag: package-2018-09-preview ``` ### Tag: package-2019-04 and go @@ -24,3 +25,12 @@ Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-2018-09-preview' && $(go) +output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2018-09-01/$(namespace) +``` diff --git a/specification/resourcegraph/resource-manager/readme.md b/specification/resourcegraph/resource-manager/readme.md index ccd79c65170c..d86fc8b81f55 100644 --- a/specification/resourcegraph/resource-manager/readme.md +++ b/specification/resourcegraph/resource-manager/readme.md @@ -56,7 +56,8 @@ These settings apply only when `--tag=package-2018-09-preview` is specified on t ``` yaml $(tag) == 'package-2018-09-preview' input-file: -- Microsoft.ResourceGraph/preview/2018-09-01-preview/resourcegraph.json + - Microsoft.ResourceGraph/preview/2018-09-01-preview/resourcegraph.json + - Microsoft.ResourceGraph/preview/2018-09-01-preview/graphquery.json ``` # Code Generation diff --git a/specification/resources/resource-manager/readme.csharp.md b/specification/resources/resource-manager/readme.csharp.md index 8dbbc8578b4a..630c5d85a042 100644 --- a/specification/resources/resource-manager/readme.csharp.md +++ b/specification/resources/resource-manager/readme.csharp.md @@ -261,6 +261,10 @@ input-file: - Microsoft.Authorization/stable/2016-12-01/policyDefinitions.json ``` +### Profile: hybrid_2018_03_01 + +These settings apply only when `--profile=hybrid_2018_03_01` is specified on the command line. + ```yaml $(profile)=='hybrid_2018_03_01' namespace: Microsoft.Azure.Management.Profiles.$(profile).ResourceManager output-folder: $(csharp-sdks-folder)/$(profile)/Resource/Management.ResourceManager/Generated @@ -275,6 +279,10 @@ batch: - tag: package-subscriptions-2016-06 ``` +### Profile: profile_2017_03_09 + +These settings apply only when `--profile=profile_2017_03_09` is specified on the command line. + ``` yaml $(profile)=='profile_2017_03_09' namespace: Microsoft.Azure.Management.Profiles.$(profile).ResourceManager output-folder: $(csharp-sdks-folder)/$(profile)/Resource/Management.ResourceManager/Generated diff --git a/specification/search/data-plane/Microsoft.Azure.Search.Data/readme.md b/specification/search/data-plane/Microsoft.Azure.Search.Data/readme.md index 8fb753afb116..8e6b68781a3a 100644 --- a/specification/search/data-plane/Microsoft.Azure.Search.Data/readme.md +++ b/specification/search/data-plane/Microsoft.Azure.Search.Data/readme.md @@ -24,7 +24,16 @@ These are the global settings for SearchIndexClient. ``` yaml openapi-type: data-plane -tag: package-2017-11-preview +tag: package-2019-05 +``` + +### Tag: package-2019-05 + +These settings apply only when `--tag=package-2019-05` is specified on the command line. + +``` yaml $(tag) == 'package-2019-05' +input-file: +- stable/2019-05-06/searchindex.json ``` ### Tag: package-2017-11-preview diff --git a/specification/search/data-plane/Microsoft.Azure.Search.Data/stable/2019-05-06/examples/SearchIndexAutocompleteDocumentsGet.json b/specification/search/data-plane/Microsoft.Azure.Search.Data/stable/2019-05-06/examples/SearchIndexAutocompleteDocumentsGet.json new file mode 100644 index 000000000000..0fe6c765e626 --- /dev/null +++ b/specification/search/data-plane/Microsoft.Azure.Search.Data/stable/2019-05-06/examples/SearchIndexAutocompleteDocumentsGet.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "searchServiceName": "myservice", + "searchDnsSuffix": "search.windows.net", + "indexName": "myindex", + "api-version": "2019-05-06", + "autocompleteMode": "oneTerm", + "search": "washington medic", + "suggesterName": "sg", + "filter": "search.in(docId,'101,102,105')", + "fuzzy": false, + "highlightPostTag": "", + "highlightPreTag": "", + "minimumCoverage": 80, + "searchFields": ["title", "description"], + "top": 10 + }, + "responses": { + "200": { + "body": [ + { + "text": "medicaid", + "queryPlusText": "washington medicaid" + }, + { + "text": "medicare", + "queryPlusText": "washington medicare" + }, + { + "text": "medicine", + "queryPlusText": "washington medicine" + } + ] + } + } +} \ No newline at end of file diff --git a/specification/search/data-plane/Microsoft.Azure.Search.Data/stable/2019-05-06/examples/SearchIndexAutocompleteDocumentsPost.json b/specification/search/data-plane/Microsoft.Azure.Search.Data/stable/2019-05-06/examples/SearchIndexAutocompleteDocumentsPost.json new file mode 100644 index 000000000000..30f0b05d39f0 --- /dev/null +++ b/specification/search/data-plane/Microsoft.Azure.Search.Data/stable/2019-05-06/examples/SearchIndexAutocompleteDocumentsPost.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "searchServiceName": "myservice", + "searchDnsSuffix": "search.windows.net", + "indexName": "myindex", + "api-version": "2017-11-11-Preview", + "autocompleteRequest": { + "autocompleteMode": "oneTerm", + "search": "washington medic", + "suggesterName": "sg", + "filter": "search.in(docId,'101,102,105')", + "highlightPostTag": "", + "highlightPreTag": "", + "minimumCoverage": 80, + "searchFields": "title,description", + "top": 10 + } + }, + "responses": { + "200": { + "body": [ + { + "text": "medicaid", + "queryPlusText": "washington medicaid" + }, + { + "text": "medicare", + "queryPlusText": "washington medicare" + }, + { + "text": "medicine", + "queryPlusText": "washington medicine" + } + ] + } + } +} \ No newline at end of file diff --git a/specification/search/data-plane/Microsoft.Azure.Search.Data/stable/2019-05-06/examples/SearchIndexCountDocuments.json b/specification/search/data-plane/Microsoft.Azure.Search.Data/stable/2019-05-06/examples/SearchIndexCountDocuments.json new file mode 100644 index 000000000000..acc0d868dddf --- /dev/null +++ b/specification/search/data-plane/Microsoft.Azure.Search.Data/stable/2019-05-06/examples/SearchIndexCountDocuments.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "searchServiceName": "myservice", + "searchDnsSuffix": "search.windows.net", + "indexName": "myindex", + "api-version": "2017-11-11-Preview" + }, + "responses": { + "200": { + "body": 427 + } + } +} \ No newline at end of file diff --git a/specification/search/data-plane/Microsoft.Azure.Search.Data/stable/2019-05-06/examples/SearchIndexGetDocument.json b/specification/search/data-plane/Microsoft.Azure.Search.Data/stable/2019-05-06/examples/SearchIndexGetDocument.json new file mode 100644 index 000000000000..422b81720c1a --- /dev/null +++ b/specification/search/data-plane/Microsoft.Azure.Search.Data/stable/2019-05-06/examples/SearchIndexGetDocument.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "searchServiceName": "myservice", + "searchDnsSuffix": "search.windows.net", + "indexName": "myindex", + "api-version": "2019-05-06", + "key": "1", + "$select": ["docId", "title", "description"] + }, + "responses": { + "200": { + "body": { + "description": "Cheapest hotel in town", + "docId": "1", + "title": "Nice Hotel" + } + } + } +} \ No newline at end of file diff --git a/specification/search/data-plane/Microsoft.Azure.Search.Data/stable/2019-05-06/examples/SearchIndexIndexDocuments.json b/specification/search/data-plane/Microsoft.Azure.Search.Data/stable/2019-05-06/examples/SearchIndexIndexDocuments.json new file mode 100644 index 000000000000..f69a11c5d925 --- /dev/null +++ b/specification/search/data-plane/Microsoft.Azure.Search.Data/stable/2019-05-06/examples/SearchIndexIndexDocuments.json @@ -0,0 +1,94 @@ +{ + "parameters": { + "searchServiceName": "myservice", + "searchDnsSuffix": "search.windows.net", + "indexName": "myindex", + "api-version": "2019-05-06", + "batch": { + "value": [ + { + "@search.action": "upload", + "docId": "1", + "title": "Fancy Stay", + "description": "Best hotel in town" + }, + { + "@search.action": "merge", + "docId": "2", + "title": "Roach Motel" + }, + { + "@search.action": "mergeOrUpload", + "docId": "3", + "title": "Econo Motel" + }, + { + "@search.action": "delete", + "docId": "4" + } + ] + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "key": "1", + "status": true, + "errorMessage": null, + "statusCode": 201 + }, + { + "key": "2", + "status": true, + "errorMessage": null, + "statusCode": 200 + }, + { + "key": "3", + "status": true, + "errorMessage": null, + "statusCode": 200 + }, + { + "key": "4", + "status": true, + "errorMessage": null, + "statusCode": 200 + } + ] + } + }, + "207": { + "body": { + "value": [ + { + "key": "1", + "status": true, + "errorMessage": null, + "statusCode": 200 + }, + { + "key": "2", + "status": false, + "errorMessage": "Document not found.", + "statusCode": 404 + }, + { + "key": "3", + "status": true, + "errorMessage": null, + "statusCode": 200 + }, + { + "key": "4", + "status": true, + "errorMessage": null, + "statusCode": 200 + } + ] + } + } + } +} diff --git a/specification/search/data-plane/Microsoft.Azure.Search.Data/stable/2019-05-06/examples/SearchIndexSearchDocumentsGet.json b/specification/search/data-plane/Microsoft.Azure.Search.Data/stable/2019-05-06/examples/SearchIndexSearchDocumentsGet.json new file mode 100644 index 000000000000..e463f5d1acea --- /dev/null +++ b/specification/search/data-plane/Microsoft.Azure.Search.Data/stable/2019-05-06/examples/SearchIndexSearchDocumentsGet.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "searchServiceName": "myservice", + "searchDnsSuffix": "search.windows.net", + "indexName": "myindex", + "api-version": "2019-05-06", + "$count": true, + "facet": [ "category,count:10,sort:count" ], + "$filter": "rating gt 10", + "highlight": [ "title" ], + "highlightPostTag": "", + "highlightPreTag": "", + "minimumCoverage": 80, + "$orderby": [ "search.score() desc", "rating desc" ], + "queryType": "simple", + "scoringParameters": [ "currentLocation--122.123,44.77233" ], + "scoringProfile": "sp", + "search": "nice hotels", + "searchFields": [ "title", "description" ], + "searchMode": "any", + "$select": [ "docId", "title", "description" ], + "$skip": 100, + "$top": 10 + }, + "responses": { + "200": { + "body": { + "@odata.count": 25, + "@search.coverage": 80, + "@search.facets": { + "category": [ + { + "count": 1, + "value": "Economy" + }, + { + "count": 1, + "value": "Luxury" + } + ] + }, + "value": [ + { + "@search.score": 1.50, + "@search.highlights": { + "title": [ "Nice Hotel" ] + }, + "description": "Cheapest hotel in town", + "docId": "1", + "title": "Nice Hotel" + }, + { + "@search.score": 0.70, + "@search.highlights": { + "title": [ "Fancy Hotel" ] + }, + "description": "Best hotel in town", + "docId": "2", + "title": "Fancy Hotel" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/search/data-plane/Microsoft.Azure.Search.Data/stable/2019-05-06/examples/SearchIndexSearchDocumentsPost.json b/specification/search/data-plane/Microsoft.Azure.Search.Data/stable/2019-05-06/examples/SearchIndexSearchDocumentsPost.json new file mode 100644 index 000000000000..7516670b10c6 --- /dev/null +++ b/specification/search/data-plane/Microsoft.Azure.Search.Data/stable/2019-05-06/examples/SearchIndexSearchDocumentsPost.json @@ -0,0 +1,86 @@ +{ + "parameters": { + "searchServiceName": "myservice", + "searchDnsSuffix": "search.windows.net", + "indexName": "myindex", + "api-version": "2019-05-06", + "searchRequest": { + "count": true, + "facets": [ "category,count:10,sort:count" ], + "filter": "rating gt 4.0", + "highlight": "title", + "highlightPostTag": "", + "highlightPreTag": "", + "minimumCoverage": null, + "orderby": "search.score() desc,rating desc", + "queryType": "simple", + "scoringParameters": [ "currentLocation--122.123,44.77233" ], + "scoringProfile": "sp", + "search": "nice hotels", + "searchFields": "title,description", + "searchMode": "any", + "select": "docId,title,description", + "skip": 0, + "top": 10 + } + }, + "responses": { + "200": { + "body": { + "@odata.count": 25, + "@search.facets": { + "category": [ + { + "count": 1, + "value": "Economy" + }, + { + "count": 1, + "value": "Luxury" + } + ] + }, + "@search.nextPageParameters": { + "count": true, + "facets": [ "category,count:10,sort:count" ], + "filter": "rating gt 4.0", + "highlight": "title", + "highlightPostTag": "", + "highlightPreTag": "", + "minimumCoverage": null, + "orderby": "search.score() desc,rating desc", + "queryType": "simple", + "scoringParameters": [ "currentLocation--122.123,44.77233" ], + "scoringProfile": "sp", + "search": "nice hotels", + "searchFields": "title,description", + "searchMode": "any", + "select": "docId,title,description", + "skip": 2, + "top": 8 + }, + "value": [ + { + "@search.score": 1.50, + "@search.highlights": { + "title": [ "Nice Hotel" ] + }, + "description": "Cheapest hotel in town", + "docId": "1", + "title": "Nice Hotel" + }, + { + "@search.score": 0.70, + "@search.highlights": { + "title": [ "Fancy Hotel" ] + }, + "description": "Best hotel in town", + "docId": "2", + "title": "Fancy Hotel" + } + ], + "@odata.nextLink": "https://myservice.search.windows.net/indexes('myindex')/docs/search.post.search?api-version=2019-05-06" + } + } + } +} \ No newline at end of file diff --git a/specification/search/data-plane/Microsoft.Azure.Search.Data/stable/2019-05-06/examples/SearchIndexSuggestDocumentsGet.json b/specification/search/data-plane/Microsoft.Azure.Search.Data/stable/2019-05-06/examples/SearchIndexSuggestDocumentsGet.json new file mode 100644 index 000000000000..24e774eb4f8b --- /dev/null +++ b/specification/search/data-plane/Microsoft.Azure.Search.Data/stable/2019-05-06/examples/SearchIndexSuggestDocumentsGet.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "searchServiceName": "myservice", + "searchDnsSuffix": "search.windows.net", + "indexName": "myindex", + "api-version": "2019-05-06", + "$filter": "rating gt 10", + "fuzzy": false, + "highlightPostTag": "", + "highlightPreTag": "", + "minimumCoverage": 80, + "$orderby": ["search.score() desc", "rating desc"], + "search": "hote", + "searchFields": ["title"], + "suggesterName": "sg", + "$select": ["docId", "title", "description"], + "$top": 10 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "@search.text": "Nice Hotel", + "description": "Cheapest hotel in town", + "docId": "1", + "title": "Nice Hotel" + }, + { + "@search.text": "Fancy Hotel", + "description": "Best hotel in town", + "docId": "2", + "title": "Fancy Hotel" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/search/data-plane/Microsoft.Azure.Search.Data/stable/2019-05-06/examples/SearchIndexSuggestDocumentsPost.json b/specification/search/data-plane/Microsoft.Azure.Search.Data/stable/2019-05-06/examples/SearchIndexSuggestDocumentsPost.json new file mode 100644 index 000000000000..7082288d4fdc --- /dev/null +++ b/specification/search/data-plane/Microsoft.Azure.Search.Data/stable/2019-05-06/examples/SearchIndexSuggestDocumentsPost.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "searchServiceName": "myservice", + "searchDnsSuffix": "search.windows.net", + "indexName": "myindex", + "api-version": "2019-05-06", + "suggestRequest": { + "filter": "rating gt 4.0", + "highlightPostTag": "", + "highlightPreTag": "", + "minimumCoverage": 80, + "orderby": "rating desc", + "search": "hote", + "searchFields": "title", + "select": "docId,title,description", + "top": 10 + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "@search.text": "Nice Hotel", + "description": "Cheapest hotel in town", + "docId": "1", + "title": "Nice Hotel" + }, + { + "@search.text": "Fancy Hotel", + "description": "Best hotel in town", + "docId": "2", + "title": "Fancy Hotel" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/search/data-plane/Microsoft.Azure.Search.Data/stable/2019-05-06/searchindex.json b/specification/search/data-plane/Microsoft.Azure.Search.Data/stable/2019-05-06/searchindex.json new file mode 100644 index 000000000000..069dc86b0655 --- /dev/null +++ b/specification/search/data-plane/Microsoft.Azure.Search.Data/stable/2019-05-06/searchindex.json @@ -0,0 +1,1312 @@ +{ + "swagger": "2.0", + "info": { + "title": "SearchIndexClient", + "description": "Client that can be used to query an Azure Search index and upload, merge, or delete documents.", + "version": "2019-05-06", + "x-ms-code-generation-settings": { + "useDateTimeOffset": true, + "syncMethods": "None" + } + }, + "x-ms-parameterized-host": { + "hostTemplate": "https://{searchServiceName}.{searchDnsSuffix}/indexes('{indexName}')", + "useSchemePrefix": false, + "parameters": [ + { + "$ref": "#/parameters/SearchServiceNameParameter" + }, + { + "$ref": "#/parameters/SearchDnsSuffixParameter" + }, + { + "$ref": "#/parameters/IndexNameParameter" + } + ] + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/docs/$count": { + "get": { + "tags": [ + "Documents" + ], + "operationId": "Documents_Count", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Count-Documents" + }, + "x-ms-examples": { + "SearchIndexCountDocuments": { "$ref": "./examples/SearchIndexCountDocuments.json" } + }, + "description": "Queries the number of documents in the Azure Search index.", + "parameters": [ + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "type": "integer", + "format": "int64" + } + } + } + } + }, + "/docs": { + "get": { + "tags": [ + "Documents" + ], + "operationId": "Documents_SearchGet", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Search-Documents" + }, + "x-ms-examples": { + "SearchIndexSearchDocumentsGet": { "$ref": "./examples/SearchIndexSearchDocumentsGet.json" } + }, + "description": "Searches for documents in the Azure Search index.", + "parameters": [ + { + "name": "search", + "in": "query", + "type": "string", + "description": "A full-text search query expression; Use \"*\" or omit this parameter to match all documents.", + "x-ms-client-name": "SearchText" + }, + { + "name": "$count", + "in": "query", + "type": "boolean", + "description": "A value that specifies whether to fetch the total count of results. Default is false. Setting this value to true may have a performance impact. Note that the count returned is an approximation.", + "x-nullable": false, + "x-ms-client-name": "IncludeTotalResultCount", + "x-ms-parameter-grouping": { + "name": "SearchParameters" + } + }, + { + "name": "facet", + "in": "query", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi", + "description": "The list of facet expressions to apply to the search query. Each facet expression contains a field name, optionally followed by a comma-separated list of name:value pairs.", + "x-ms-client-name": "Facets", + "x-ms-parameter-grouping": { + "name": "SearchParameters" + } + }, + { + "name": "$filter", + "in": "query", + "type": "string", + "description": "The OData $filter expression to apply to the search query.", + "x-ms-parameter-grouping": { + "name": "SearchParameters" + } + }, + { + "name": "highlight", + "in": "query", + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of field names to use for hit highlights. Only searchable fields can be used for hit highlighting.", + "x-ms-client-name": "HighlightFields", + "x-ms-parameter-grouping": { + "name": "SearchParameters" + } + }, + { + "name": "highlightPostTag", + "in": "query", + "type": "string", + "description": "A string tag that is appended to hit highlights. Must be set with highlightPreTag. Default is </em>.", + "x-ms-parameter-grouping": { + "name": "SearchParameters" + } + }, + { + "name": "highlightPreTag", + "in": "query", + "type": "string", + "description": "A string tag that is prepended to hit highlights. Must be set with highlightPostTag. Default is <em>.", + "x-ms-parameter-grouping": { + "name": "SearchParameters" + } + }, + { + "name": "minimumCoverage", + "in": "query", + "type": "number", + "format": "double", + "description": "A number between 0 and 100 indicating the percentage of the index that must be covered by a search query in order for the query to be reported as a success. This parameter can be useful for ensuring search availability even for services with only one replica. The default is 100.", + "x-ms-parameter-grouping": { + "name": "SearchParameters" + } + }, + { + "name": "$orderby", + "in": "query", + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of OData $orderby expressions by which to sort the results. Each expression can be either a field name or a call to either the geo.distance() or the search.score() functions. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order. Ties will be broken by the match scores of documents. If no OrderBy is specified, the default sort order is descending by document match score. There can be at most 32 $orderby clauses.", + "x-ms-client-name": "OrderBy", + "x-ms-parameter-grouping": { + "name": "SearchParameters" + } + }, + { + "name": "queryType", + "in": "query", + "type": "string", + "enum": [ + "simple", + "full" + ], + "x-ms-enum": { + "name": "QueryType", + "modelAsString": false + }, + "x-nullable": false, + "description": "A value that specifies the syntax of the search query. The default is 'simple'. Use 'full' if your query uses the Lucene query syntax.", + "x-ms-parameter-grouping": { + "name": "SearchParameters" + } + }, + { + "name": "scoringParameter", + "in": "query", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi", + "x-ms-client-name": "ScoringParameters", + "description": "The list of parameter values to be used in scoring functions (for example, referencePointParameter) using the format name-values. For example, if the scoring profile defines a function with a parameter called 'mylocation' the parameter string would be \"mylocation--122.2,44.8\" (without the quotes).", + "x-ms-parameter-grouping": { + "name": "SearchParameters" + } + }, + { + "name": "scoringProfile", + "in": "query", + "type": "string", + "description": "The name of a scoring profile to evaluate match scores for matching documents in order to sort the results.", + "x-ms-parameter-grouping": { + "name": "SearchParameters" + } + }, + { + "name": "searchFields", + "in": "query", + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of field names to include in the full-text search.", + "x-ms-parameter-grouping": { + "name": "SearchParameters" + } + }, + { + "name": "searchMode", + "in": "query", + "type": "string", + "enum": [ + "any", + "all" + ], + "x-ms-enum": { + "name": "SearchMode", + "modelAsString": false + }, + "x-nullable": false, + "description": "A value that specifies whether any or all of the search terms must be matched in order to count the document as a match.", + "x-ms-parameter-grouping": { + "name": "SearchParameters" + } + }, + { + "name": "$select", + "in": "query", + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of fields to retrieve. If unspecified, all fields marked as retrievable in the schema are included.", + "x-ms-parameter-grouping": { + "name": "SearchParameters" + } + }, + { + "name": "$skip", + "in": "query", + "type": "integer", + "format": "int32", + "description": "The number of search results to skip. This value cannot be greater than 100,000. If you need to scan documents in sequence, but cannot use $skip due to this limitation, consider using $orderby on a totally-ordered key and $filter with a range query instead.", + "x-ms-parameter-grouping": { + "name": "SearchParameters" + } + }, + { + "name": "$top", + "in": "query", + "type": "integer", + "format": "int32", + "description": "The number of search results to retrieve. This can be used in conjunction with $skip to implement client-side paging of search results. If results are truncated due to server-side paging, the response will include a continuation token that can be used to issue another Search request for the next page of results.", + "x-ms-parameter-grouping": { + "name": "SearchParameters" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "Response containing documents that match the search criteria.", + "schema": { + "$ref": "#/definitions/DocumentSearchResult" + } + } + } + } + }, + "/docs/search.post.search": { + "post": { + "tags": [ + "Documents" + ], + "operationId": "Documents_SearchPost", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Search-Documents" + }, + "x-ms-examples": { + "SearchIndexSearchDocumentsPost": { "$ref": "./examples/SearchIndexSearchDocumentsPost.json" } + }, + "description": "Searches for documents in the Azure Search index.", + "parameters": [ + { + "name": "searchRequest", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SearchRequest", + "description": "The Search request." + }, + "description": "The definition of the Search request." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "Response containing documents that match the search criteria.", + "schema": { + "$ref": "#/definitions/DocumentSearchResult" + } + } + } + } + }, + "/docs('{key}')": { + "get": { + "tags": [ + "Documents" + ], + "operationId": "Documents_Get", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/lookup-document" + }, + "x-ms-examples": { + "SearchIndexGetDocument": { "$ref": "./examples/SearchIndexGetDocument.json" } + }, + "description": "Retrieves a document from the Azure Search index.", + "parameters": [ + { + "name": "key", + "in": "path", + "required": true, + "description": "The key of the document to retrieve.", + "type": "string" + }, + { + "name": "$select", + "in": "query", + "type": "array", + "items": { + "type": "string" + }, + "description": "List of field names to retrieve for the document; Any field not retrieved will be missing from the returned document.", + "x-ms-client-name": "SelectedFields" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + } + ], + "responses": { + "200": { + "description": "Response containing the requested document.", + "schema": { + "type": "object" + } + } + } + } + }, + "/docs/search.suggest": { + "get": { + "tags": [ + "Documents" + ], + "operationId": "Documents_SuggestGet", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/suggestions" + }, + "x-ms-examples": { + "SearchIndexSuggestDocumentsGet": { "$ref": "./examples/SearchIndexSuggestDocumentsGet.json" } + }, + "description": "Suggests documents in the Azure Search index that match the given partial query text.", + "parameters": [ + { + "name": "search", + "in": "query", + "required": true, + "type": "string", + "description": "The search text to use to suggest documents. Must be at least 1 character, and no more than 100 characters.", + "x-ms-client-name": "SearchText" + }, + { + "name": "suggesterName", + "in": "query", + "required": true, + "type": "string", + "description": "The name of the suggester as specified in the suggesters collection that's part of the index definition." + }, + { + "name": "$filter", + "in": "query", + "type": "string", + "description": "An OData expression that filters the documents considered for suggestions.", + "x-ms-parameter-grouping": { + "name": "SuggestParameters" + } + }, + { + "name": "fuzzy", + "in": "query", + "type": "boolean", + "description": "A value indicating whether to use fuzzy matching for the suggestions query. Default is false. When set to true, the query will find terms even if there's a substituted or missing character in the search text. While this provides a better experience in some scenarios, it comes at a performance cost as fuzzy suggestions queries are slower and consume more resources.", + "x-ms-client-name": "UseFuzzyMatching", + "x-nullable": false, + "x-ms-parameter-grouping": { + "name": "SuggestParameters" + } + }, + { + "name": "highlightPostTag", + "in": "query", + "type": "string", + "description": "A string tag that is appended to hit highlights. Must be set with highlightPreTag. If omitted, hit highlighting of suggestions is disabled.", + "x-ms-parameter-grouping": { + "name": "SuggestParameters" + } + }, + { + "name": "highlightPreTag", + "in": "query", + "type": "string", + "description": "A string tag that is prepended to hit highlights. Must be set with highlightPostTag. If omitted, hit highlighting of suggestions is disabled.", + "x-ms-parameter-grouping": { + "name": "SuggestParameters" + } + }, + { + "name": "minimumCoverage", + "in": "query", + "type": "number", + "format": "double", + "description": "A number between 0 and 100 indicating the percentage of the index that must be covered by a suggestions query in order for the query to be reported as a success. This parameter can be useful for ensuring search availability even for services with only one replica. The default is 80.", + "x-ms-parameter-grouping": { + "name": "SuggestParameters" + } + }, + { + "name": "$orderby", + "in": "query", + "type": "array", + "items": { + "type": "string" + }, + "x-ms-client-name": "OrderBy", + "description": "The list of OData $orderby expressions by which to sort the results. Each expression can be either a field name or a call to either the geo.distance() or the search.score() functions. Each expression can be followed by asc to indicate ascending, or desc to indicate descending. The default is ascending order. Ties will be broken by the match scores of documents. If no $orderby is specified, the default sort order is descending by document match score. There can be at most 32 $orderby clauses.", + "x-ms-parameter-grouping": { + "name": "SuggestParameters" + } + }, + { + "name": "searchFields", + "in": "query", + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of field names to search for the specified search text. Target fields must be included in the specified suggester.", + "x-ms-parameter-grouping": { + "name": "SuggestParameters" + } + }, + { + "name": "$select", + "in": "query", + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of fields to retrieve. If unspecified, only the key field will be included in the results.", + "x-ms-parameter-grouping": { + "name": "SuggestParameters" + } + }, + { + "name": "$top", + "in": "query", + "type": "integer", + "format": "int32", + "description": "The number of suggestions to retrieve. The value must be a number between 1 and 100. The default is 5.", + "x-ms-parameter-grouping": { + "name": "SuggestParameters" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "Response containing suggested documents that match the partial input.", + "schema": { + "$ref": "#/definitions/DocumentSuggestResult" + } + } + } + } + }, + "/docs/search.post.suggest": { + "post": { + "tags": [ + "Documents" + ], + "operationId": "Documents_SuggestPost", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/suggestions" + }, + "x-ms-examples": { + "SearchIndexSuggestDocumentsPost": { "$ref": "./examples/SearchIndexSuggestDocumentsPost.json" } + }, + "description": "Suggests documents in the Azure Search index that match the given partial query text.", + "parameters": [ + { + "name": "suggestRequest", + "in": "body", + "required": true, + "description": "The Suggest request.", + "schema": { + "$ref": "#/definitions/SuggestRequest" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "Response containing suggested documents that match the partial input.", + "schema": { + "$ref": "#/definitions/DocumentSuggestResult" + } + } + } + } + }, + "/docs/search.index": { + "post": { + "tags": [ + "Documents" + ], + "operationId": "Documents_Index", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/addupdate-or-delete-documents" + }, + "x-ms-examples": { + "SearchIndexIndexDocuments": { "$ref": "./examples/SearchIndexIndexDocuments.json" } + }, + "description": "Sends a batch of document write actions to the Azure Search index.", + "parameters": [ + { + "name": "batch", + "in": "body", + "description": "The batch of index actions.", + "required": true, + "schema": { + "$ref": "#/definitions/IndexBatch" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "Response containing the status of operations for all actions in the batch.", + "schema": { + "$ref": "#/definitions/DocumentIndexResult" + } + }, + "207": { + "description": "Response containing the status of operations for all actions in the batch.", + "schema": { + "$ref": "#/definitions/DocumentIndexResult" + } + } + } + } + }, + "/docs/search.autocomplete": { + "get": { + "tags": [ + "Documents" + ], + "operationId": "Documents_AutocompleteGet", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/autocomplete" + }, + "x-ms-examples": { + "SearchIndexAutocompleteDocumentsGet": { "$ref": "./examples/SearchIndexAutocompleteDocumentsGet.json" } + }, + "description": "Autocompletes incomplete query terms based on input text and matching terms in the Azure Search index.", + "parameters": [ + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "search", + "in": "query", + "type": "string", + "required": true, + "description": "The incomplete term which should be auto-completed.", + "x-ms-client-name": "SearchText" + }, + { + "name": "suggesterName", + "in": "query", + "type": "string", + "required": true, + "description": "The name of the suggester as specified in the suggesters collection that's part of the index definition." + }, + { + "name": "autocompleteMode", + "in": "query", + "type": "string", + "x-nullable": false, + "enum": [ + "oneTerm", + "twoTerms", + "oneTermWithContext" + ], + "x-ms-enum": { + "name": "AutocompleteMode", + "modelAsString": false + }, + "description": "Specifies the mode for Autocomplete. The default is 'oneTerm'. Use 'twoTerms' to get shingles and 'oneTermWithContext' to use the current context while producing auto-completed terms.", + "x-ms-parameter-grouping": { + "name": "AutocompleteParameters" + } + }, + { + "name": "$filter", + "in": "query", + "type": "string", + "description": "An OData expression that filters the documents used to produce completed terms for the Autocomplete result.", + "x-ms-parameter-grouping": { + "name": "AutocompleteParameters" + } + }, + { + "name": "fuzzy", + "in": "query", + "type": "boolean", + "description": "A value indicating whether to use fuzzy matching for the autocomplete query. Default is false. When set to true, the query will find terms even if there's a substituted or missing character in the search text. While this provides a better experience in some scenarios, it comes at a performance cost as fuzzy autocomplete queries are slower and consume more resources.", + "x-ms-client-name": "UseFuzzyMatching", + "x-ms-parameter-grouping": { + "name": "AutocompleteParameters" + } + }, + { + "name": "highlightPostTag", + "in": "query", + "type": "string", + "description": "A string tag that is appended to hit highlights. Must be set with highlightPreTag. If omitted, hit highlighting is disabled.", + "x-ms-parameter-grouping": { + "name": "AutocompleteParameters" + } + }, + { + "name": "highlightPreTag", + "in": "query", + "type": "string", + "description": "A string tag that is prepended to hit highlights. Must be set with highlightPostTag. If omitted, hit highlighting is disabled.", + "x-ms-parameter-grouping": { + "name": "AutocompleteParameters" + } + }, + { + "name": "minimumCoverage", + "in": "query", + "type": "number", + "format": "double", + "description": "A number between 0 and 100 indicating the percentage of the index that must be covered by an autocomplete query in order for the query to be reported as a success. This parameter can be useful for ensuring search availability even for services with only one replica. The default is 80.", + "x-ms-parameter-grouping": { + "name": "AutocompleteParameters" + } + }, + { + "name": "searchFields", + "in": "query", + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of field names to consider when querying for auto-completed terms. Target fields must be included in the specified suggester.", + "x-ms-parameter-grouping": { + "name": "AutocompleteParameters" + } + }, + { + "name": "$top", + "in": "query", + "type": "integer", + "format": "int32", + "description": "The number of auto-completed terms to retrieve. This must be a value between 1 and 100. The default is 5.", + "x-ms-parameter-grouping": { + "name": "AutocompleteParameters" + } + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/AutocompleteResult", + "description": "The result of Autocomplete query." + } + } + } + } + }, + "/docs/search.post.autocomplete": { + "post": { + "tags": [ + "Documents" + ], + "operationId": "Documents_AutocompletePost", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/autocomplete" + }, + "x-ms-examples": { + "SearchIndexAutocompleteDocumentsPost": { "$ref": "./examples/SearchIndexAutocompleteDocumentsPost.json" } + }, + "description": "Autocompletes incomplete query terms based on input text and matching terms in the Azure Search index.", + "parameters": [ + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "autocompleteRequest", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AutocompleteRequest" + }, + "description": "The definition of the Autocomplete request." + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/AutocompleteResult", + "description": "The result of Autocomplete query." + } + } + } + } + } + }, + "definitions": { + "DocumentSuggestResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/SuggestResult" + }, + "readOnly": true, + "x-ms-client-name": "Results", + "description": "The sequence of results returned by the query." + }, + "@search.coverage": { + "type": "number", + "readOnly": true, + "format": "double", + "x-ms-client-name": "Coverage", + "description": "A value indicating the percentage of the index that was included in the query, or null if minimumCoverage was not set in the request." + } + }, + "description": "Response containing suggestion query results from an Azure Search index." + }, + "SuggestResult": { + "properties": { + "@search.text": { + "type": "string", + "readOnly": true, + "description": "The text of the suggestion result.", + "x-ms-client-name": "Text" + } + }, + "additionalProperties": true, + "description": "A result containing a document found by a suggestion query, plus associated metadata." + }, + "FacetResult": { + "properties": { + "count": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "The approximate count of documents falling within the bucket described by this facet." + } + }, + "additionalProperties": true, + "description": "A single bucket of a facet query result. Reports the number of documents with a field value falling within a particular range or having a particular value or interval." + }, + "DocumentSearchResult": { + "properties": { + "@odata.count": { + "type": "integer", + "format": "int64", + "readOnly": true, + "x-ms-client-name": "Count", + "description": "The total count of results found by the search operation, or null if the count was not requested. If present, the count may be greater than the number of results in this response. This can happen if you use the $top or $skip parameters, or if Azure Search can't return all the requested documents in a single Search response." + }, + "@search.coverage": { + "type": "number", + "format": "double", + "readOnly": true, + "x-ms-client-name": "Coverage", + "description": "A value indicating the percentage of the index that was included in the query, or null if minimumCoverage was not specified in the request." + }, + "@search.facets": { + "type": "object", + "additionalProperties": { + "type": "array", + "items": { + "$ref": "#/definitions/FacetResult" + } + }, + "readOnly": true, + "x-ms-client-name": "Facets", + "description": "The facet query results for the search operation, organized as a collection of buckets for each faceted field; null if the query did not include any facet expressions." + }, + "@search.nextPageParameters": { + "$ref": "#/definitions/SearchRequest", + "readOnly": true, + "x-ms-client-name": "NextPageParameters", + "description": "Continuation JSON payload returned when Azure Search can't return all the requested results in a single Search response. You can use this JSON along with @odata.nextLink to formulate another POST Search request to get the next part of the search response." + }, + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/SearchResult" + }, + "readOnly": true, + "x-ms-client-name": "Results", + "description": "The sequence of results returned by the query." + }, + "@odata.nextLink": { + "type": "string", + "readOnly": true, + "x-ms-client-name": "NextLink", + "description": "Continuation URL returned when Azure Search can't return all the requested results in a single Search response. You can use this URL to formulate another GET or POST Search request to get the next part of the search response. Make sure to use the same verb (GET or POST) as the request that produced this response." + } + }, + "description": "Response containing search results from an Azure Search index." + }, + "SearchResult": { + "properties": { + "@search.score": { + "type": "number", + "format": "double", + "readOnly": true, + "x-ms-client-name": "Score", + "x-nullable": false, + "description": "The relevance score of the document compared to other documents returned by the query." + }, + "@search.highlights": { + "type": "object", + "additionalProperties": { + "type": "array", + "items": { + "type": "string" + } + }, + "readOnly": true, + "x-ms-client-name": "Highlights", + "description": "Text fragments from the document that indicate the matching search terms, organized by each applicable field; null if hit highlighting was not enabled for the query." + } + }, + "additionalProperties": true, + "description": "Contains a document found by a search query, plus associated metadata." + }, + "IndexBatch": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/IndexAction" + }, + "description": "The actions in the batch.", + "x-ms-client-name": "Actions" + } + }, + "required": ["value"], + "description": "Contains a batch of document write actions to send to the Azure Search index." + }, + "IndexAction": { + "properties": { + "@search.action": { + "type": "string", + "enum": [ + "upload", + "merge", + "mergeOrUpload", + "delete" + ], + "x-ms-enum": { "name": "IndexActionType" }, + "x-ms-client-name": "ActionType", + "x-nullable": false, + "description": "The operation to perform on a document in an indexing batch." + } + }, + "additionalProperties": true, + "description": "Represents an index action that operates on a document." + }, + "IndexingResult": { + "properties": { + "key": { + "type": "string", + "readOnly": true, + "description": "The key of a document that was in the indexing request." + }, + "errorMessage": { + "type": "string", + "readOnly": true, + "description": "The error message explaining why the indexing operation failed for the document identified by the key; null if indexing succeeded." + }, + "status": { + "x-ms-client-name": "Succeeded", + "type": "boolean", + "x-nullable": false, + "readOnly": true, + "description": "A value indicating whether the indexing operation succeeded for the document identified by the key." + }, + "statusCode": { + "type": "integer", + "format": "int32", + "x-nullable": false, + "readOnly": true, + "description": "The status code of the indexing operation. Possible values include: 200 for a successful update or delete, 201 for successful document creation, 400 for a malformed input document, 404 for document not found, 409 for a version conflict, 422 when the index is temporarily unavailable, or 503 for when the service is too busy." + } + }, + "description": "Status of an indexing operation for a single document." + }, + "DocumentIndexResult": { + "properties": { + "value": { + "x-ms-client-name": "Results", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/IndexingResult" + }, + "description": "The list of status information for each document in the indexing request." + } + }, + "description": "Response containing the status of operations for all documents in the indexing request." + }, + "SearchMode": { + "type": "string", + "enum": [ + "any", + "all" + ], + "x-ms-enum": { + "name": "SearchMode", + "modelAsString": false + }, + "description": "Specifies whether any or all of the search terms must be matched in order to count the document as a match." + }, + "QueryType": { + "type": "string", + "enum": [ + "simple", + "full" + ], + "x-ms-enum": { + "name": "QueryType", + "modelAsString": false + }, + "description": "Specifies the syntax of the search query. The default is 'simple'. Use 'full' if your query uses the Lucene query syntax." + }, + "AutocompleteMode": { + "type": "string", + "enum": [ + "oneTerm", + "twoTerms", + "oneTermWithContext" + ], + "x-ms-enum": { + "name": "AutocompleteMode", + "modelAsString" : false + }, + "description": "Specifies the mode for Autocomplete. The default is 'oneTerm'. Use 'twoTerms' to get shingles and 'oneTermWithContext' to use the current context in producing autocomplete terms." + }, + "SearchRequest": { + "properties": { + "count": { + "type": "boolean", + "description": "A value that specifies whether to fetch the total count of results. Default is false. Setting this value to true may have a performance impact. Note that the count returned is an approximation.", + "x-ms-client-name": "IncludeTotalResultCount" + }, + "facets": { + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Search-Documents" + }, + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of facet expressions to apply to the search query. Each facet expression contains a field name, optionally followed by a comma-separated list of name:value pairs." + }, + "filter": { + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/OData-Expression-Syntax-for-Azure-Search" + }, + "type": "string", + "description": "The OData $filter expression to apply to the search query." + }, + "highlight": { + "type": "string", + "description": "The comma-separated list of field names to use for hit highlights. Only searchable fields can be used for hit highlighting.", + "x-ms-client-name": "HighlightFields" + }, + "highlightPostTag": { + "type": "string", + "description": "A string tag that is appended to hit highlights. Must be set with highlightPreTag. Default is </em>." + }, + "highlightPreTag": { + "type": "string", + "description": "A string tag that is prepended to hit highlights. Must be set with highlightPostTag. Default is <em>." + }, + "minimumCoverage": { + "type": "number", + "format": "double", + "description": "A number between 0 and 100 indicating the percentage of the index that must be covered by a search query in order for the query to be reported as a success. This parameter can be useful for ensuring search availability even for services with only one replica. The default is 100." + }, + "orderby": { + "x-ms-client-name": "OrderBy", + "type": "string", + "description": "The comma-separated list of OData $orderby expressions by which to sort the results. Each expression can be either a field name or a call to either the geo.distance() or the search.score() functions. Each expression can be followed by asc to indicate ascending, or desc to indicate descending. The default is ascending order. Ties will be broken by the match scores of documents. If no $orderby is specified, the default sort order is descending by document match score. There can be at most 32 $orderby clauses." + }, + "queryType": { + "$ref": "#/definitions/QueryType", + "description": "A value that specifies the syntax of the search query. The default is 'simple'. Use 'full' if your query uses the Lucene query syntax." + }, + "scoringParameters": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of parameter values to be used in scoring functions (for example, referencePointParameter) using the format name-values. For example, if the scoring profile defines a function with a parameter called 'mylocation' the parameter string would be \"mylocation--122.2,44.8\" (without the quotes)." + }, + "scoringProfile": { + "type": "string", + "description": "The name of a scoring profile to evaluate match scores for matching documents in order to sort the results." + }, + "search": { + "type": "string", + "description": "A full-text search query expression; Use \"*\" or omit this parameter to match all documents.", + "x-ms-client-name": "SearchText" + }, + "searchFields": { + "type": "string", + "description": "The comma-separated list of field names to include in the full-text search." + }, + "searchMode": { + "$ref": "#/definitions/SearchMode", + "description": "A value that specifies whether any or all of the search terms must be matched in order to count the document as a match." + }, + "select": { + "type": "string", + "description": "The comma-separated list of fields to retrieve. If unspecified, all fields marked as retrievable in the schema are included." + }, + "skip": { + "type": "integer", + "format": "int32", + "description": "The number of search results to skip. This value cannot be greater than 100,000. If you need to scan documents in sequence, but cannot use skip due to this limitation, consider using orderby on a totally-ordered key and filter with a range query instead." + }, + "top": { + "type": "integer", + "format": "int32", + "description": "The number of search results to retrieve. This can be used in conjunction with $skip to implement client-side paging of search results. If results are truncated due to server-side paging, the response will include a continuation token that can be used to issue another Search request for the next page of results." + } + }, + "description": "Parameters for filtering, sorting, faceting, paging, and other search query behaviors." + }, + "SuggestRequest": { + "properties": { + "filter": { + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/OData-Expression-Syntax-for-Azure-Search" + }, + "type": "string", + "description": "An OData expression that filters the documents considered for suggestions." + }, + "fuzzy": { + "type": "boolean", + "description": "A value indicating whether to use fuzzy matching for the suggestion query. Default is false. When set to true, the query will find suggestions even if there's a substituted or missing character in the search text. While this provides a better experience in some scenarios, it comes at a performance cost as fuzzy suggestion searches are slower and consume more resources.", + "x-ms-client-name": "UseFuzzyMatching" + }, + "highlightPostTag": { + "type": "string", + "description": "A string tag that is appended to hit highlights. Must be set with highlightPreTag. If omitted, hit highlighting of suggestions is disabled." + }, + "highlightPreTag": { + "type": "string", + "description": "A string tag that is prepended to hit highlights. Must be set with highlightPostTag. If omitted, hit highlighting of suggestions is disabled." + }, + "minimumCoverage": { + "type": "number", + "format": "double", + "description": "A number between 0 and 100 indicating the percentage of the index that must be covered by a suggestion query in order for the query to be reported as a success. This parameter can be useful for ensuring search availability even for services with only one replica. The default is 80." + }, + "orderby": { + "x-ms-client-name": "OrderBy", + "type": "string", + "description": "The comma-separated list of OData $orderby expressions by which to sort the results. Each expression can be either a field name or a call to either the geo.distance() or the search.score() functions. Each expression can be followed by asc to indicate ascending, or desc to indicate descending. The default is ascending order. Ties will be broken by the match scores of documents. If no $orderby is specified, the default sort order is descending by document match score. There can be at most 32 $orderby clauses." + }, + "search": { + "type": "string", + "description": "The search text to use to suggest documents. Must be at least 1 character, and no more than 100 characters.", + "x-ms-client-name": "SearchText" + }, + "searchFields": { + "type": "string", + "description": "The list of comma-separated field names to search for the specified search text. Target fields must be included in the specified suggester." + }, + "select": { + "type": "string", + "description": "The comma-separated list of fields to retrieve. If unspecified, only the key field will be included in the results." + }, + "suggesterName": { + "type": "string", + "description": "The name of the suggester as specified in the suggesters collection that's part of the index definition." + }, + "top": { + "type": "integer", + "format": "int32", + "description": "The number of suggestions to retrieve. This must be a value between 1 and 100. The default is 5." + } + }, + "description": "Parameters for filtering, sorting, fuzzy matching, and other suggestions query behaviors." + }, + "AutocompleteRequest": { + "properties": { + "search": { + "type": "string", + "description": "The search text on which to base autocomplete results.", + "x-ms-client-name": "SearchText" + }, + "autocompleteMode": { + "$ref": "#/definitions/AutocompleteMode", + "description": "Specifies the mode for Autocomplete. The default is 'oneTerm'. Use 'twoTerms' to get shingles and 'oneTermWithContext' to use the current context while producing auto-completed terms." + }, + "filter": { + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/OData-Expression-Syntax-for-Azure-Search" + }, + "type": "string", + "description": "An OData expression that filters the documents used to produce completed terms for the Autocomplete result." + }, + "fuzzy": { + "type": "boolean", + "description": "A value indicating whether to use fuzzy matching for the autocomplete query. Default is false. When set to true, the query will autocomplete terms even if there's a substituted or missing character in the search text. While this provides a better experience in some scenarios, it comes at a performance cost as fuzzy autocomplete queries are slower and consume more resources.", + "x-ms-client-name": "UseFuzzyMatching" + }, + "highlightPostTag": { + "type": "string", + "description": "A string tag that is appended to hit highlights. Must be set with highlightPreTag. If omitted, hit highlighting is disabled." + }, + "highlightPreTag": { + "type": "string", + "description": "A string tag that is prepended to hit highlights. Must be set with highlightPostTag. If omitted, hit highlighting is disabled." + }, + "minimumCoverage": { + "type": "number", + "format": "double", + "description": "A number between 0 and 100 indicating the percentage of the index that must be covered by an autocomplete query in order for the query to be reported as a success. This parameter can be useful for ensuring search availability even for services with only one replica. The default is 80." + }, + "searchFields": { + "type": "string", + "description": "The comma-separated list of field names to consider when querying for auto-completed terms. Target fields must be included in the specified suggester." + }, + "suggesterName": { + "type": "string", + "description": "The name of the suggester as specified in the suggesters collection that's part of the index definition." + }, + "top": { + "type": "integer", + "format": "int32", + "description": "The number of auto-completed terms to retrieve. This must be a value between 1 and 100. The default is 5." + } + }, + "description": "Parameters for fuzzy matching, and other autocomplete query behaviors." + }, + "AutocompleteResult" : { + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/AutocompleteItem" + }, + "description": "The list of returned Autocompleted items.", + "x-ms-client-name": "Results" + } + }, + "description": "The result of Autocomplete query." + }, + "AutocompleteItem": { + "properties": { + "text": { + "type": "string", + "readOnly": true, + "description": "The completed term." + }, + "queryPlusText": { + "type": "string", + "readOnly": true, + "description": "The query along with the completed term." + } + }, + "description": "The result of Autocomplete requests." + } + }, + "parameters": { + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client Api Version." + }, + "ClientRequestIdParameter": { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The tracking ID sent with the request to help with debugging.", + "x-ms-client-request-id": true, + "x-ms-parameter-grouping": { "name": "search-request-options" }, + "x-ms-parameter-location": "method" + }, + "SearchServiceNameParameter": { + "name": "searchServiceName", + "in": "path", + "required": true, + "type": "string", + "x-ms-skip-url-encoding": true, + "description": "The name of the Azure Search service.", + "x-ms-parameter-location": "client" + }, + "SearchDnsSuffixParameter": { + "name": "searchDnsSuffix", + "in": "path", + "required": true, + "type": "string", + "default": "search.windows.net", + "x-ms-skip-url-encoding": true, + "description": "The DNS suffix of the Azure Search service. The default is search.windows.net.", + "x-ms-parameter-location": "client" + }, + "IndexNameParameter": { + "name": "indexName", + "in": "path", + "required": true, + "type": "string", + "x-ms-skip-url-encoding": false, + "description": "The name of the Azure Search index.", + "x-ms-parameter-location": "client" + } + } +} \ No newline at end of file diff --git a/specification/search/data-plane/Microsoft.Azure.Search.Service/readme.md b/specification/search/data-plane/Microsoft.Azure.Search.Service/readme.md index 928dae45bdd6..ac62eea97986 100644 --- a/specification/search/data-plane/Microsoft.Azure.Search.Service/readme.md +++ b/specification/search/data-plane/Microsoft.Azure.Search.Service/readme.md @@ -24,7 +24,16 @@ These are the global settings for SearchServiceClient. ``` yaml openapi-type: data-plane -tag: package-2017-11-preview +tag: package-2019-05 +``` + +### Tag: package-2019-05 + +These settings apply only when `--tag=package-2019-05` is specified on the command line. + +``` yaml $(tag) == 'package-2019-05' +input-file: +- stable/2019-05-06/searchservice.json ``` ### Tag: package-2017-11-preview diff --git a/specification/search/data-plane/Microsoft.Azure.Search.Service/stable/2019-05-06/examples/SearchServiceCreateDataSource.json b/specification/search/data-plane/Microsoft.Azure.Search.Service/stable/2019-05-06/examples/SearchServiceCreateDataSource.json new file mode 100644 index 000000000000..2fd6d22ba4b6 --- /dev/null +++ b/specification/search/data-plane/Microsoft.Azure.Search.Service/stable/2019-05-06/examples/SearchServiceCreateDataSource.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "searchServiceName": "myservice", + "searchDnsSuffix": "search.windows.net", + "api-version": "2019-05-06", + "dataSource": { + "name": "mydocdbdatasource", + "description": "My Cosmos DB data source.", + "type": "cosmosdb", + "credentials": { + "connectionString": "AccountEndpoint=https://myDocDbEndpoint.documents.azure.com;AccountKey=myDocDbAuthKey;Database=myDocDbDatabaseId" + }, + "container": { + "name": "myDocDbCollectionId", + "query": "SELECT c.id, c.userId, tag, c._ts FROM c JOIN tag IN c.tags WHERE c._ts >= @HighWaterMark ORDER BY c._ts" + }, + "dataChangeDetectionPolicy": { + "@odata.type": "#Microsoft.Azure.Search.HighWaterMarkChangeDetectionPolicy", + "highWaterMarkColumnName": "_ts" + }, + "dataDeletionDetectionPolicy": { + "@odata.type": "#Microsoft.Azure.Search.SoftDeleteColumnDeletionDetectionPolicy", + "softDeleteColumnName": "isDeleted", + "softDeleteMarkerValue": "true" + } + } + }, + "responses": { + "201": { + "body": { + "name": "mydocdbdatasource", + "description": "My Cosmos DB data source.", + "type": "cosmosdb", + "credentials": { + "connectionString": null + }, + "container": { + "name": "myDocDbCollectionId", + "query": "SELECT c.id, c.userId, tag, c._ts FROM c JOIN tag IN c.tags WHERE c._ts >= @HighWaterMark ORDER BY c._ts" + }, + "dataChangeDetectionPolicy": { + "@odata.type": "#Microsoft.Azure.Search.HighWaterMarkChangeDetectionPolicy", + "highWaterMarkColumnName": "_ts" + }, + "dataDeletionDetectionPolicy": { + "@odata.type": "#Microsoft.Azure.Search.SoftDeleteColumnDeletionDetectionPolicy", + "softDeleteColumnName": "isDeleted", + "softDeleteMarkerValue": "true" + } + } + } + } +} \ No newline at end of file diff --git a/specification/search/data-plane/Microsoft.Azure.Search.Service/stable/2019-05-06/examples/SearchServiceCreateIndex.json b/specification/search/data-plane/Microsoft.Azure.Search.Service/stable/2019-05-06/examples/SearchServiceCreateIndex.json new file mode 100644 index 000000000000..652a7cce93b8 --- /dev/null +++ b/specification/search/data-plane/Microsoft.Azure.Search.Service/stable/2019-05-06/examples/SearchServiceCreateIndex.json @@ -0,0 +1,346 @@ +{ + "parameters": { + "searchServiceName": "myservice", + "searchDnsSuffix": "search.windows.net", + "api-version": "2019-05-06", + "index": { + "name": "hotels", + "fields": [ + { + "name": "hotelId", + "type": "Edm.String", + "key": true, + "searchable": false + }, + { + "name": "baseRate", + "type": "Edm.Double" + }, + { + "name": "description", + "type": "Edm.String", + "filterable": false, + "sortable": false, + "facetable": false + }, + { + "name": "description_fr", + "type": "Edm.String", + "filterable": false, + "sortable": false, + "facetable": false, + "analyzer": "fr.lucene" + }, + { + "name": "hotelName", + "type": "Edm.String" + }, + { + "name": "category", + "type": "Edm.String" + }, + { + "name": "tags", + "type": "Collection(Edm.String)", + "analyzer": "tagsAnalyzer" + }, + { + "name": "parkingIncluded", + "type": "Edm.Boolean" + }, + { + "name": "smokingAllowed", + "type": "Edm.Boolean" + }, + { + "name": "lastRenovationDate", + "type": "Edm.DateTimeOffset" + }, + { + "name": "rating", + "type": "Edm.Int32" + }, + { + "name": "location", + "type": "Edm.GeographyPoint" + } + ], + "scoringProfiles": [ + { + "name": "geo", + "text": { + "weights": { + "hotelName": 5 + } + }, + "functions": [ + { + "type": "distance", + "boost": 5, + "fieldName": "location", + "interpolation": "logarithmic", + "distance": { + "referencePointParameter": "currentLocation", + "boostingDistance": 10 + } + } + ] + } + ], + "defaultScoringProfile": "geo", + "suggesters": [ + { + "name": "sg", + "searchMode": "analyzingInfixMatching", + "sourceFields": [ + "hotelName" + ] + } + ], + "analyzers": [ + { + "name": "tagsAnalyzer", + "@odata.type": "#Microsoft.Azure.Search.CustomAnalyzer", + "charFilters": [ + "html_strip" + ], + "tokenizer": "standard_v2" + } + ], + "corsOptions": { + "allowedOrigins": [ + "tempuri.org" + ], + "maxAgeInSeconds": 60 + } + } + }, + "responses": { + "201": { + "body": { + "name": "hotels", + "fields": [ + { + "name": "hotelId", + "type": "Edm.String", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": true, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "baseRate", + "type": "Edm.Double", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "description", + "type": "Edm.String", + "searchable": true, + "filterable": false, + "retrievable": true, + "sortable": false, + "facetable": false, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "description_fr", + "type": "Edm.String", + "searchable": true, + "filterable": false, + "retrievable": true, + "sortable": false, + "facetable": false, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": "fr.lucene", + "synonymMaps": [] + }, + { + "name": "hotelName", + "type": "Edm.String", + "searchable": true, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "category", + "type": "Edm.String", + "searchable": true, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "tags", + "type": "Collection(Edm.String)", + "searchable": true, + "filterable": true, + "retrievable": true, + "sortable": false, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": "tagsAnalyzer", + "synonymMaps": [] + }, + { + "name": "parkingIncluded", + "type": "Edm.Boolean", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "smokingAllowed", + "type": "Edm.Boolean", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "lastRenovationDate", + "type": "Edm.DateTimeOffset", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "rating", + "type": "Edm.Int32", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "location", + "type": "Edm.GeographyPoint", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": false, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + } + ], + "scoringProfiles": [ + { + "name": "geo", + "text": { + "weights": { + "hotelName": 5 + } + }, + "functions": [ + { + "type": "distance", + "boost": 5, + "fieldName": "location", + "interpolation": "logarithmic", + "distance": { + "referencePointParameter": "currentLocation", + "boostingDistance": 10 + } + } + ] + } + ], + "defaultScoringProfile": "geo", + "suggesters": [ + { + "name": "sg", + "searchMode": "analyzingInfixMatching", + "sourceFields": [ + "hotelName" + ] + } + ], + "analyzers": [ + { + "name": "tagsAnalyzer", + "@odata.type": "#Microsoft.Azure.Search.CustomAnalyzer", + "charFilters": [ + "html_strip" + ], + "tokenizer": "standard_v2" + } + ], + "tokenizers": [], + "tokenFilters": [], + "charFilters": [], + "corsOptions": { + "allowedOrigins": [ + "tempuri.org" + ], + "maxAgeInSeconds": 60 + } + } + } + } +} \ No newline at end of file diff --git a/specification/search/data-plane/Microsoft.Azure.Search.Service/stable/2019-05-06/examples/SearchServiceCreateIndexer.json b/specification/search/data-plane/Microsoft.Azure.Search.Service/stable/2019-05-06/examples/SearchServiceCreateIndexer.json new file mode 100644 index 000000000000..4c3e08b131b0 --- /dev/null +++ b/specification/search/data-plane/Microsoft.Azure.Search.Service/stable/2019-05-06/examples/SearchServiceCreateIndexer.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "searchServiceName": "myservice", + "searchDnsSuffix": "search.windows.net", + "api-version": "2019-05-06", + "indexer": { + "name": "myindexer", + "description": "a cool indexer", + "dataSourceName": "mydatasource", + "targetIndexName": "orders", + "schedule": { + "interval": "PT1H", + "startTime": "2015-01-01T00:00:00Z" + }, + "parameters": { + "maxFailedItems": 10, + "maxFailedItemsPerBatch": 5 + } + } + }, + "responses": { + "201": { + "body": { + "name": "myindexer", + "description": "a cool indexer", + "dataSourceName": "mydatasource", + "targetIndexName": "orders", + "schedule": { + "interval": "PT1H", + "startTime": "2015-01-01T00:00:00Z" + }, + "parameters": { + "maxFailedItems": 10, + "maxFailedItemsPerBatch": 5 + }, + "fieldMappings": [], + "disabled": false + } + } + } +} \ No newline at end of file diff --git a/specification/search/data-plane/Microsoft.Azure.Search.Service/stable/2019-05-06/examples/SearchServiceCreateOrUpdateDataSource.json b/specification/search/data-plane/Microsoft.Azure.Search.Service/stable/2019-05-06/examples/SearchServiceCreateOrUpdateDataSource.json new file mode 100644 index 000000000000..c1af51b87082 --- /dev/null +++ b/specification/search/data-plane/Microsoft.Azure.Search.Service/stable/2019-05-06/examples/SearchServiceCreateOrUpdateDataSource.json @@ -0,0 +1,78 @@ +{ + "parameters": { + "searchServiceName": "myservice", + "searchDnsSuffix": "search.windows.net", + "dataSourceName": "mydatasource", + "api-version": "2019-05-06", + "Prefer": "return=representation", + "dataSource": { + "name": "mydocdbdatasource", + "description": "My Cosmos DB data source.", + "type": "cosmosdb", + "credentials": { + "connectionString": "AccountEndpoint=https://myDocDbEndpoint.documents.azure.com;AccountKey=myDocDbAuthKey;Database=myDocDbDatabaseId" + }, + "container": { + "name": "myDocDbCollectionId", + "query": "SELECT c.id, c.userId, tag, c._ts FROM c JOIN tag IN c.tags WHERE c._ts >= @HighWaterMark ORDER BY c._ts" + }, + "dataChangeDetectionPolicy": { + "@odata.type": "#Microsoft.Azure.Search.HighWaterMarkChangeDetectionPolicy", + "highWaterMarkColumnName": "_ts" + }, + "dataDeletionDetectionPolicy": { + "@odata.type": "#Microsoft.Azure.Search.SoftDeleteColumnDeletionDetectionPolicy", + "softDeleteColumnName": "isDeleted", + "softDeleteMarkerValue": "true" + } + } + }, + "responses": { + "200": { + "body": { + "name": "mydocdbdatasource", + "description": "My Cosmos DB data source.", + "type": "cosmosdb", + "credentials": { + "connectionString": null + }, + "container": { + "name": "myDocDbCollectionId", + "query": "SELECT c.id, c.userId, tag, c._ts FROM c JOIN tag IN c.tags WHERE c._ts >= @HighWaterMark ORDER BY c._ts" + }, + "dataChangeDetectionPolicy": { + "@odata.type": "#Microsoft.Azure.Search.HighWaterMarkChangeDetectionPolicy", + "highWaterMarkColumnName": "_ts" + }, + "dataDeletionDetectionPolicy": { + "@odata.type": "#Microsoft.Azure.Search.SoftDeleteColumnDeletionDetectionPolicy", + "softDeleteColumnName": "isDeleted", + "softDeleteMarkerValue": "true" + } + } + }, + "201": { + "body": { + "name": "mydocdbdatasource", + "description": "My Cosmos DB data source.", + "type": "cosmosdb", + "credentials": { + "connectionString": null + }, + "container": { + "name": "myDocDbCollectionId", + "query": "SELECT c.id, c.userId, tag, c._ts FROM c JOIN tag IN c.tags WHERE c._ts >= @HighWaterMark ORDER BY c._ts" + }, + "dataChangeDetectionPolicy": { + "@odata.type": "#Microsoft.Azure.Search.HighWaterMarkChangeDetectionPolicy", + "highWaterMarkColumnName": "_ts" + }, + "dataDeletionDetectionPolicy": { + "@odata.type": "#Microsoft.Azure.Search.SoftDeleteColumnDeletionDetectionPolicy", + "softDeleteColumnName": "isDeleted", + "softDeleteMarkerValue": "true" + } + } + } + } +} \ No newline at end of file diff --git a/specification/search/data-plane/Microsoft.Azure.Search.Service/stable/2019-05-06/examples/SearchServiceCreateOrUpdateIndex.json b/specification/search/data-plane/Microsoft.Azure.Search.Service/stable/2019-05-06/examples/SearchServiceCreateOrUpdateIndex.json new file mode 100644 index 000000000000..e5ffd75fdea4 --- /dev/null +++ b/specification/search/data-plane/Microsoft.Azure.Search.Service/stable/2019-05-06/examples/SearchServiceCreateOrUpdateIndex.json @@ -0,0 +1,575 @@ +{ + "parameters": { + "searchServiceName": "myservice", + "searchDnsSuffix": "search.windows.net", + "indexName": "hotels", + "allowIndexDowntime": false, + "api-version": "2019-05-06", + "Prefer": "return=representation", + "index": { + "name": "hotels", + "fields": [ + { + "name": "hotelId", + "type": "Edm.String", + "key": true, + "searchable": false + }, + { + "name": "baseRate", + "type": "Edm.Double" + }, + { + "name": "description", + "type": "Edm.String", + "filterable": false, + "sortable": false, + "facetable": false + }, + { + "name": "description_fr", + "type": "Edm.String", + "filterable": false, + "sortable": false, + "facetable": false, + "analyzer": "fr.lucene" + }, + { + "name": "hotelName", + "type": "Edm.String" + }, + { + "name": "category", + "type": "Edm.String" + }, + { + "name": "tags", + "type": "Collection(Edm.String)", + "analyzer": "tagsAnalyzer" + }, + { + "name": "parkingIncluded", + "type": "Edm.Boolean" + }, + { + "name": "smokingAllowed", + "type": "Edm.Boolean" + }, + { + "name": "lastRenovationDate", + "type": "Edm.DateTimeOffset" + }, + { + "name": "rating", + "type": "Edm.Int32" + }, + { + "name": "location", + "type": "Edm.GeographyPoint" + } + ], + "scoringProfiles": [ + { + "name": "geo", + "text": { + "weights": { + "hotelName": 5 + } + }, + "functions": [ + { + "type": "distance", + "boost": 5, + "fieldName": "location", + "interpolation": "logarithmic", + "distance": { + "referencePointParameter": "currentLocation", + "boostingDistance": 10 + } + } + ] + } + ], + "defaultScoringProfile": "geo", + "suggesters": [ + { + "name": "sg", + "searchMode": "analyzingInfixMatching", + "sourceFields": [ + "hotelName" + ] + } + ], + "analyzers": [ + { + "name": "tagsAnalyzer", + "@odata.type": "#Microsoft.Azure.Search.CustomAnalyzer", + "charFilters": [ + "html_strip" + ], + "tokenizer": "standard_v2" + } + ], + "corsOptions": { + "allowedOrigins": [ + "tempuri.org" + ], + "maxAgeInSeconds": 60 + } + } + }, + "responses": { + "200": { + "body": { + "name": "hotels", + "fields": [ + { + "name": "hotelId", + "type": "Edm.String", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": true, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "baseRate", + "type": "Edm.Double", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "description", + "type": "Edm.String", + "searchable": true, + "filterable": false, + "retrievable": true, + "sortable": false, + "facetable": false, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "description_fr", + "type": "Edm.String", + "searchable": true, + "filterable": false, + "retrievable": true, + "sortable": false, + "facetable": false, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": "fr.lucene", + "synonymMaps": [] + }, + { + "name": "hotelName", + "type": "Edm.String", + "searchable": true, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "category", + "type": "Edm.String", + "searchable": true, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "tags", + "type": "Collection(Edm.String)", + "searchable": true, + "filterable": true, + "retrievable": true, + "sortable": false, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": "tagsAnalyzer", + "synonymMaps": [] + }, + { + "name": "parkingIncluded", + "type": "Edm.Boolean", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "smokingAllowed", + "type": "Edm.Boolean", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "lastRenovationDate", + "type": "Edm.DateTimeOffset", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "rating", + "type": "Edm.Int32", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "location", + "type": "Edm.GeographyPoint", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": false, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + } + ], + "scoringProfiles": [ + { + "name": "geo", + "text": { + "weights": { + "hotelName": 5 + } + }, + "functions": [ + { + "type": "distance", + "boost": 5, + "fieldName": "location", + "interpolation": "logarithmic", + "distance": { + "referencePointParameter": "currentLocation", + "boostingDistance": 10 + } + } + ] + } + ], + "defaultScoringProfile": "geo", + "suggesters": [ + { + "name": "sg", + "searchMode": "analyzingInfixMatching", + "sourceFields": [ + "hotelName" + ] + } + ], + "analyzers": [ + { + "name": "tagsAnalyzer", + "@odata.type": "#Microsoft.Azure.Search.CustomAnalyzer", + "charFilters": [ + "html_strip" + ], + "tokenizer": "standard_v2" + } + ], + "tokenizers": [], + "tokenFilters": [], + "charFilters": [], + "corsOptions": { + "allowedOrigins": [ + "tempuri.org" + ], + "maxAgeInSeconds": 60 + } + } + }, + "201": { + "body": { + "name": "hotels", + "fields": [ + { + "name": "hotelId", + "type": "Edm.String", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": true, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "baseRate", + "type": "Edm.Double", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "description", + "type": "Edm.String", + "searchable": true, + "filterable": false, + "retrievable": true, + "sortable": false, + "facetable": false, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "description_fr", + "type": "Edm.String", + "searchable": true, + "filterable": false, + "retrievable": true, + "sortable": false, + "facetable": false, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": "fr.lucene", + "synonymMaps": [] + }, + { + "name": "hotelName", + "type": "Edm.String", + "searchable": true, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "category", + "type": "Edm.String", + "searchable": true, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "tags", + "type": "Collection(Edm.String)", + "searchable": true, + "filterable": true, + "retrievable": true, + "sortable": false, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": "tagsAnalyzer", + "synonymMaps": [] + }, + { + "name": "parkingIncluded", + "type": "Edm.Boolean", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "smokingAllowed", + "type": "Edm.Boolean", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "lastRenovationDate", + "type": "Edm.DateTimeOffset", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "rating", + "type": "Edm.Int32", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "location", + "type": "Edm.GeographyPoint", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": false, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + } + ], + "scoringProfiles": [ + { + "name": "geo", + "text": { + "weights": { + "hotelName": 5 + } + }, + "functions": [ + { + "type": "distance", + "boost": 5, + "fieldName": "location", + "interpolation": "logarithmic", + "distance": { + "referencePointParameter": "currentLocation", + "boostingDistance": 10 + } + } + ] + } + ], + "defaultScoringProfile": "geo", + "suggesters": [ + { + "name": "sg", + "searchMode": "analyzingInfixMatching", + "sourceFields": [ + "hotelName" + ] + } + ], + "analyzers": [ + { + "name": "tagsAnalyzer", + "@odata.type": "#Microsoft.Azure.Search.CustomAnalyzer", + "charFilters": [ + "html_strip" + ], + "tokenizer": "standard_v2" + } + ], + "tokenizers": [], + "tokenFilters": [], + "charFilters": [], + "corsOptions": { + "allowedOrigins": [ + "tempuri.org" + ], + "maxAgeInSeconds": 60 + } + } + } + } +} \ No newline at end of file diff --git a/specification/search/data-plane/Microsoft.Azure.Search.Service/stable/2019-05-06/examples/SearchServiceCreateOrUpdateIndexer.json b/specification/search/data-plane/Microsoft.Azure.Search.Service/stable/2019-05-06/examples/SearchServiceCreateOrUpdateIndexer.json new file mode 100644 index 000000000000..ba9f42b0fd4f --- /dev/null +++ b/specification/search/data-plane/Microsoft.Azure.Search.Service/stable/2019-05-06/examples/SearchServiceCreateOrUpdateIndexer.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "searchServiceName": "myservice", + "searchDnsSuffix": "search.windows.net", + "indexerName": "myindexer", + "api-version": "2019-05-06", + "Prefer": "return=representation", + "indexer": { + "name": "myindexer", + "description": "a cool indexer", + "dataSourceName": "mydatasource", + "targetIndexName": "orders", + "schedule": { + "interval": "PT1H", + "startTime": "2015-01-01T00:00:00Z" + }, + "parameters": { + "maxFailedItems": 10, + "maxFailedItemsPerBatch": 5 + } + } + }, + "responses": { + "200": { + "body": { + "name": "myindexer", + "description": "a cool indexer", + "dataSourceName": "mydatasource", + "targetIndexName": "orders", + "schedule": { + "interval": "PT1H", + "startTime": "2015-01-01T00:00:00Z" + }, + "parameters": { + "maxFailedItems": 10, + "maxFailedItemsPerBatch": 5 + }, + "fieldMappings": [], + "disabled": false + } + }, + "201": { + "body": { + "name": "myindexer", + "description": "a cool indexer", + "dataSourceName": "mydatasource", + "targetIndexName": "orders", + "schedule": { + "interval": "PT1H", + "startTime": "2015-01-01T00:00:00Z" + }, + "parameters": { + "maxFailedItems": 10, + "maxFailedItemsPerBatch": 5 + }, + "fieldMappings": [], + "disabled": false + } + } + } +} \ No newline at end of file diff --git a/specification/search/data-plane/Microsoft.Azure.Search.Service/stable/2019-05-06/examples/SearchServiceCreateOrUpdateSkillset.json b/specification/search/data-plane/Microsoft.Azure.Search.Service/stable/2019-05-06/examples/SearchServiceCreateOrUpdateSkillset.json new file mode 100644 index 000000000000..731e909988d9 --- /dev/null +++ b/specification/search/data-plane/Microsoft.Azure.Search.Service/stable/2019-05-06/examples/SearchServiceCreateOrUpdateSkillset.json @@ -0,0 +1,281 @@ +{ + "parameters": { + "searchServiceName": "myservice", + "searchDnsSuffix": "search.windows.net", + "skillsetName": "demoskillset", + "api-version": "2019-05-06", + "Prefer": "return=representation", + "skillset": { + "name": "demoskillset", + "description": "Extract entities, detect language and extract key-phrases", + "skills": [ + { + "@odata.type": "#Microsoft.Skills.Text.EntityRecognitionSkill", + "categories": [ + "organization" + ], + "defaultLanguageCode": "en", + "minimumPrecision": 0.7, + "inputs": [ + { + "name": "text", + "source": "/document/content" + } + ], + "outputs": [ + { + "name": "organizations", + "targetName": "organizations" + } + ] + }, + { + "@odata.type": "#Microsoft.Skills.Text.LanguageDetectionSkill", + "inputs": [ + { + "name": "text", + "source": "/document/content" + } + ], + "outputs": [ + { + "name": "languageCode", + "targetName": "languageCode" + } + ] + }, + { + "@odata.type": "#Microsoft.Skills.Text.SplitSkill", + "textSplitMode": "pages", + "maximumPageLength": 4000, + "inputs": [ + { + "name": "text", + "source": "/document/content" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "textItems", + "targetName": "pages" + } + ] + }, + { + "@odata.type": "#Microsoft.Skills.Text.KeyPhraseExtractionSkill", + "context": "/document/pages/*", + "inputs": [ + { + "name": "text", + "source": "/document/pages/*" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "keyPhrases", + "targetName": "keyPhrases" + } + ] + } + ] + } + }, + "responses": { + "200": { + "body": { + "name": "demoskillset", + "description": "Extract entities, detect language and extract key-phrases", + "skills": [ + { + "@odata.type": "#Microsoft.Skills.Text.EntityRecognitionSkill", + "description": null, + "context": null, + "inputs": [ + { + "name": "text", + "source": "/document/content" + } + ], + "outputs": [ + { + "name": "organizations", + "targetName": "organizations" + } + ], + "categories": [ + "organization" + ], + "defaultLanguageCode": "en", + "minimumPrecision": 0.7 + }, + { + "@odata.type": "#Microsoft.Skills.Text.LanguageDetectionSkill", + "description": null, + "context": null, + "inputs": [ + { + "name": "text", + "source": "/document/content" + } + ], + "outputs": [ + { + "name": "languageCode", + "targetName": "languageCode" + } + ] + }, + { + "@odata.type": "#Microsoft.Skills.Text.SplitSkill", + "description": null, + "context": null, + "inputs": [ + { + "name": "text", + "source": "/document/content" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "textItems", + "targetName": "pages" + } + ], + "defaultLanguageCode": null, + "textSplitMode": "pages", + "maximumPageLength": 4000 + }, + { + "@odata.type": "#Microsoft.Skills.Text.KeyPhraseExtractionSkill", + "description": null, + "context": "/document/pages/*", + "inputs": [ + { + "name": "text", + "source": "/document/pages/*" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "keyPhrases", + "targetName": "keyPhrases" + } + ], + "defaultLanguageCode": null, + "maxKeyPhraseCount": null + } + ] + } + }, + "201": { + "body": { + "name": "demoskillset", + "description": "Extract entities, detect language and extract key-phrases", + "skills": [ + { + "@odata.type": "#Microsoft.Skills.Text.EntityRecognitionSkill", + "description": null, + "context": null, + "inputs": [ + { + "name": "text", + "source": "/document/content" + } + ], + "outputs": [ + { + "name": "organizations", + "targetName": "organizations" + } + ], + "categories": [ + "organization" + ], + "defaultLanguageCode": "en", + "minimumPrecision": 0.7 + }, + { + "@odata.type": "#Microsoft.Skills.Text.LanguageDetectionSkill", + "description": null, + "context": null, + "inputs": [ + { + "name": "text", + "source": "/document/content" + } + ], + "outputs": [ + { + "name": "languageCode", + "targetName": "languageCode" + } + ] + }, + { + "@odata.type": "#Microsoft.Skills.Text.SplitSkill", + "description": null, + "context": null, + "inputs": [ + { + "name": "text", + "source": "/document/content" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "textItems", + "targetName": "pages" + } + ], + "defaultLanguageCode": null, + "textSplitMode": "pages", + "maximumPageLength": 4000 + }, + { + "@odata.type": "#Microsoft.Skills.Text.KeyPhraseExtractionSkill", + "description": null, + "context": "/document/pages/*", + "inputs": [ + { + "name": "text", + "source": "/document/pages/*" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "keyPhrases", + "targetName": "keyPhrases" + } + ], + "defaultLanguageCode": null, + "maxKeyPhraseCount": null + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/search/data-plane/Microsoft.Azure.Search.Service/stable/2019-05-06/examples/SearchServiceCreateOrUpdateSynonymMap.json b/specification/search/data-plane/Microsoft.Azure.Search.Service/stable/2019-05-06/examples/SearchServiceCreateOrUpdateSynonymMap.json new file mode 100644 index 000000000000..4ebff4f1f201 --- /dev/null +++ b/specification/search/data-plane/Microsoft.Azure.Search.Service/stable/2019-05-06/examples/SearchServiceCreateOrUpdateSynonymMap.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "searchServiceName": "myservice", + "searchDnsSuffix": "search.windows.net", + "synonymMapName": "mysynonymmap", + "api-version": "2019-05-06", + "Prefer": "return=representation", + "synonymMap": { + "name": "mysynonymmap", + "format": "solr", + "synonyms": "United States, United States of America, USA\nWashington, Wash. => WA" + } + }, + "responses": { + "200": { + "body": { + "name": "mysynonymmap", + "format": "solr", + "synonyms": "United States, United States of America, USA\nWashington, Wash. => WA" + } + }, + "201": { + "body": { + "name": "mysynonymmap", + "format": "solr", + "synonyms": "United States, United States of America, USA\nWashington, Wash. => WA" + } + } + } +} \ No newline at end of file diff --git a/specification/search/data-plane/Microsoft.Azure.Search.Service/stable/2019-05-06/examples/SearchServiceCreateSkillset.json b/specification/search/data-plane/Microsoft.Azure.Search.Service/stable/2019-05-06/examples/SearchServiceCreateSkillset.json new file mode 100644 index 000000000000..03501f6cba0e --- /dev/null +++ b/specification/search/data-plane/Microsoft.Azure.Search.Service/stable/2019-05-06/examples/SearchServiceCreateSkillset.json @@ -0,0 +1,187 @@ +{ + "parameters": { + "searchServiceName": "myservice", + "searchDnsSuffix": "search.windows.net", + "skillsetName": "demoskillset", + "api-version": "2019-05-06", + "Prefer": "return=representation", + "skillset": { + "name": "demoskillset", + "description": "Extract entities, detect language and extract key-phrases", + "skills": [ + { + "@odata.type": "#Microsoft.Skills.Text.EntityRecognitionSkill", + "categories": [ + "organization" + ], + "defaultLanguageCode": "en", + "minimumPrecision": 0.7, + "inputs": [ + { + "name": "text", + "source": "/document/content" + } + ], + "outputs": [ + { + "name": "organizations", + "targetName": "organizations" + } + ] + }, + { + "@odata.type": "#Microsoft.Skills.Text.LanguageDetectionSkill", + "inputs": [ + { + "name": "text", + "source": "/document/content" + } + ], + "outputs": [ + { + "name": "languageCode", + "targetName": "languageCode" + } + ] + }, + { + "@odata.type": "#Microsoft.Skills.Text.SplitSkill", + "textSplitMode": "pages", + "maximumPageLength": 4000, + "inputs": [ + { + "name": "text", + "source": "/document/content" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "textItems", + "targetName": "pages" + } + ] + }, + { + "@odata.type": "#Microsoft.Skills.Text.KeyPhraseExtractionSkill", + "context": "/document/pages/*", + "inputs": [ + { + "name": "text", + "source": "/document/pages/*" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "keyPhrases", + "targetName": "keyPhrases" + } + ] + } + ] + } + }, + "responses": { + "201": { + "body": { + "name": "demoskillset", + "description": "Extract entities, detect language and extract key-phrases", + "skills": [ + { + "@odata.type": "#Microsoft.Skills.Text.EntityRecognitionSkill", + "description": null, + "context": null, + "inputs": [ + { + "name": "text", + "source": "/document/content" + } + ], + "outputs": [ + { + "name": "organizations", + "targetName": "organizations" + } + ], + "categories": [ + "organization" + ], + "defaultLanguageCode": "en", + "minimumPrecision": 0.7 + }, + { + "@odata.type": "#Microsoft.Skills.Text.LanguageDetectionSkill", + "description": null, + "context": null, + "inputs": [ + { + "name": "text", + "source": "/document/content" + } + ], + "outputs": [ + { + "name": "languageCode", + "targetName": "languageCode" + } + ] + }, + { + "@odata.type": "#Microsoft.Skills.Text.SplitSkill", + "description": null, + "context": null, + "inputs": [ + { + "name": "text", + "source": "/document/content" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "textItems", + "targetName": "pages" + } + ], + "defaultLanguageCode": null, + "textSplitMode": "pages", + "maximumPageLength": 4000 + }, + { + "@odata.type": "#Microsoft.Skills.Text.KeyPhraseExtractionSkill", + "description": null, + "context": "/document/pages/*", + "inputs": [ + { + "name": "text", + "source": "/document/pages/*" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "keyPhrases", + "targetName": "keyPhrases" + } + ], + "defaultLanguageCode": null, + "maxKeyPhraseCount": null + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/search/data-plane/Microsoft.Azure.Search.Service/stable/2019-05-06/examples/SearchServiceCreateSynonymMap.json b/specification/search/data-plane/Microsoft.Azure.Search.Service/stable/2019-05-06/examples/SearchServiceCreateSynonymMap.json new file mode 100644 index 000000000000..e9a49beeecda --- /dev/null +++ b/specification/search/data-plane/Microsoft.Azure.Search.Service/stable/2019-05-06/examples/SearchServiceCreateSynonymMap.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "searchServiceName": "myservice", + "searchDnsSuffix": "search.windows.net", + "api-version": "2019-05-06", + "synonymMap": { + "name": "mysynonymmap", + "format": "solr", + "synonyms": "United States, United States of America, USA\nWashington, Wash. => WA" + } + }, + "responses": { + "201": { + "body": { + "name": "mysynonymmap", + "format": "solr", + "synonyms": "United States, United States of America, USA\nWashington, Wash. => WA" + } + } + } +} \ No newline at end of file diff --git a/specification/search/data-plane/Microsoft.Azure.Search.Service/stable/2019-05-06/examples/SearchServiceDeleteDataSource.json b/specification/search/data-plane/Microsoft.Azure.Search.Service/stable/2019-05-06/examples/SearchServiceDeleteDataSource.json new file mode 100644 index 000000000000..1ecbb42987a2 --- /dev/null +++ b/specification/search/data-plane/Microsoft.Azure.Search.Service/stable/2019-05-06/examples/SearchServiceDeleteDataSource.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "searchServiceName": "myservice", + "searchDnsSuffix": "search.windows.net", + "dataSourceName": "mydatasource", + "api-version": "2019-05-06" + }, + "responses": { + "204": {}, + "404": {} + } +} \ No newline at end of file diff --git a/specification/search/data-plane/Microsoft.Azure.Search.Service/stable/2019-05-06/examples/SearchServiceDeleteIndex.json b/specification/search/data-plane/Microsoft.Azure.Search.Service/stable/2019-05-06/examples/SearchServiceDeleteIndex.json new file mode 100644 index 000000000000..b83ea37d290f --- /dev/null +++ b/specification/search/data-plane/Microsoft.Azure.Search.Service/stable/2019-05-06/examples/SearchServiceDeleteIndex.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "searchServiceName": "myservice", + "searchDnsSuffix": "search.windows.net", + "indexName": "myindex", + "api-version": "2019-05-06" + }, + "responses": { + "204": {}, + "404": {} + } +} \ No newline at end of file diff --git a/specification/search/data-plane/Microsoft.Azure.Search.Service/stable/2019-05-06/examples/SearchServiceDeleteIndexer.json b/specification/search/data-plane/Microsoft.Azure.Search.Service/stable/2019-05-06/examples/SearchServiceDeleteIndexer.json new file mode 100644 index 000000000000..f255e2701480 --- /dev/null +++ b/specification/search/data-plane/Microsoft.Azure.Search.Service/stable/2019-05-06/examples/SearchServiceDeleteIndexer.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "searchServiceName": "myservice", + "searchDnsSuffix": "search.windows.net", + "indexerName": "myindexer", + "api-version": "2019-05-06" + }, + "responses": { + "204": {}, + "404": {} + } +} \ No newline at end of file diff --git a/specification/search/data-plane/Microsoft.Azure.Search.Service/stable/2019-05-06/examples/SearchServiceDeleteSkillset.json b/specification/search/data-plane/Microsoft.Azure.Search.Service/stable/2019-05-06/examples/SearchServiceDeleteSkillset.json new file mode 100644 index 000000000000..bca4fce7b818 --- /dev/null +++ b/specification/search/data-plane/Microsoft.Azure.Search.Service/stable/2019-05-06/examples/SearchServiceDeleteSkillset.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "searchServiceName": "myservice", + "searchDnsSuffix": "search.windows.net", + "skillsetName": "demoskillset", + "api-version": "2019-05-06" + }, + "responses": { + "204": {}, + "404": {} + } +} \ No newline at end of file diff --git a/specification/search/data-plane/Microsoft.Azure.Search.Service/stable/2019-05-06/examples/SearchServiceDeleteSynonymMap.json b/specification/search/data-plane/Microsoft.Azure.Search.Service/stable/2019-05-06/examples/SearchServiceDeleteSynonymMap.json new file mode 100644 index 000000000000..d74e19007808 --- /dev/null +++ b/specification/search/data-plane/Microsoft.Azure.Search.Service/stable/2019-05-06/examples/SearchServiceDeleteSynonymMap.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "searchServiceName": "myservice", + "searchDnsSuffix": "search.windows.net", + "synonymMapName": "mysynonymmap", + "api-version": "2019-05-06" + }, + "responses": { + "204": {}, + "404": {} + } +} \ No newline at end of file diff --git a/specification/search/data-plane/Microsoft.Azure.Search.Service/stable/2019-05-06/examples/SearchServiceGetDataSource.json b/specification/search/data-plane/Microsoft.Azure.Search.Service/stable/2019-05-06/examples/SearchServiceGetDataSource.json new file mode 100644 index 000000000000..1e5240b73a74 --- /dev/null +++ b/specification/search/data-plane/Microsoft.Azure.Search.Service/stable/2019-05-06/examples/SearchServiceGetDataSource.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "searchServiceName": "myservice", + "searchDnsSuffix": "search.windows.net", + "dataSourceName": "mydatasource", + "api-version": "2019-05-06" + }, + "responses": { + "200": { + "body": { + "name": "mydocdbdatasource", + "description": "My Cosmos DB data source.", + "type": "cosmosdb", + "credentials": { + "connectionString": null + }, + "container": { + "name": "myDocDbCollectionId", + "query": "SELECT c.id, c.userId, tag, c._ts FROM c JOIN tag IN c.tags WHERE c._ts >= @HighWaterMark ORDER BY c._ts" + }, + "dataChangeDetectionPolicy": { + "@odata.type": "#Microsoft.Azure.Search.HighWaterMarkChangeDetectionPolicy", + "highWaterMarkColumnName": "_ts" + }, + "dataDeletionDetectionPolicy": { + "@odata.type": "#Microsoft.Azure.Search.SoftDeleteColumnDeletionDetectionPolicy", + "softDeleteColumnName": "isDeleted", + "softDeleteMarkerValue": "true" + } + } + } + } +} \ No newline at end of file diff --git a/specification/search/data-plane/Microsoft.Azure.Search.Service/stable/2019-05-06/examples/SearchServiceGetIndex.json b/specification/search/data-plane/Microsoft.Azure.Search.Service/stable/2019-05-06/examples/SearchServiceGetIndex.json new file mode 100644 index 000000000000..52064f3ee892 --- /dev/null +++ b/specification/search/data-plane/Microsoft.Azure.Search.Service/stable/2019-05-06/examples/SearchServiceGetIndex.json @@ -0,0 +1,236 @@ +{ + "parameters": { + "searchServiceName": "myservice", + "searchDnsSuffix": "search.windows.net", + "indexName": "hotels", + "api-version": "2019-05-06" + }, + "responses": { + "200": { + "body": { + "name": "hotels", + "fields": [ + { + "name": "hotelId", + "type": "Edm.String", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": true, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "baseRate", + "type": "Edm.Double", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "description", + "type": "Edm.String", + "searchable": true, + "filterable": false, + "retrievable": true, + "sortable": false, + "facetable": false, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "description_fr", + "type": "Edm.String", + "searchable": true, + "filterable": false, + "retrievable": true, + "sortable": false, + "facetable": false, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": "fr.lucene", + "synonymMaps": [] + }, + { + "name": "hotelName", + "type": "Edm.String", + "searchable": true, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "category", + "type": "Edm.String", + "searchable": true, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "tags", + "type": "Collection(Edm.String)", + "searchable": true, + "filterable": true, + "retrievable": true, + "sortable": false, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": "tagsAnalyzer", + "synonymMaps": [] + }, + { + "name": "parkingIncluded", + "type": "Edm.Boolean", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "smokingAllowed", + "type": "Edm.Boolean", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "lastRenovationDate", + "type": "Edm.DateTimeOffset", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "rating", + "type": "Edm.Int32", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "location", + "type": "Edm.GeographyPoint", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": false, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + } + ], + "scoringProfiles": [ + { + "name": "geo", + "text": { + "weights": { + "hotelName": 5 + } + }, + "functions": [ + { + "type": "distance", + "boost": 5, + "fieldName": "location", + "interpolation": "logarithmic", + "distance": { + "referencePointParameter": "currentLocation", + "boostingDistance": 10 + } + } + ] + } + ], + "defaultScoringProfile": "geo", + "suggesters": [ + { + "name": "sg", + "searchMode": "analyzingInfixMatching", + "sourceFields": [ + "hotelName" + ] + } + ], + "analyzers": [ + { + "name": "tagsAnalyzer", + "@odata.type": "#Microsoft.Azure.Search.CustomAnalyzer", + "charFilters": [ + "html_strip" + ], + "tokenizer": "standard_v2" + } + ], + "tokenizers": [], + "tokenFilters": [], + "charFilters": [], + "corsOptions": { + "allowedOrigins": [ + "tempuri.org" + ], + "maxAgeInSeconds": 60 + } + } + } + } +} \ No newline at end of file diff --git a/specification/search/data-plane/Microsoft.Azure.Search.Service/stable/2019-05-06/examples/SearchServiceGetIndexStatistics.json b/specification/search/data-plane/Microsoft.Azure.Search.Service/stable/2019-05-06/examples/SearchServiceGetIndexStatistics.json new file mode 100644 index 000000000000..c13df23a9044 --- /dev/null +++ b/specification/search/data-plane/Microsoft.Azure.Search.Service/stable/2019-05-06/examples/SearchServiceGetIndexStatistics.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "searchServiceName": "myservice", + "searchDnsSuffix": "search.windows.net", + "indexName": "hotels", + "api-version": "2019-05-06" + }, + "responses": { + "200": { + "body": { + "documentCount": 239572, + "storageSize": 72375920 + } + } + } +} \ No newline at end of file diff --git a/specification/search/data-plane/Microsoft.Azure.Search.Service/stable/2019-05-06/examples/SearchServiceGetIndexer.json b/specification/search/data-plane/Microsoft.Azure.Search.Service/stable/2019-05-06/examples/SearchServiceGetIndexer.json new file mode 100644 index 000000000000..e6a7b306a024 --- /dev/null +++ b/specification/search/data-plane/Microsoft.Azure.Search.Service/stable/2019-05-06/examples/SearchServiceGetIndexer.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "searchServiceName": "myservice", + "searchDnsSuffix": "search.windows.net", + "indexerName": "myindexer", + "api-version": "2019-05-06" + }, + "responses": { + "200": { + "body": { + "name": "myindexer", + "description": "a cool indexer", + "dataSourceName": "mydatasource", + "targetIndexName": "orders", + "schedule": { + "interval": "PT1H", + "startTime": "2015-01-01T00:00:00Z" + }, + "parameters": { + "maxFailedItems": 10, + "maxFailedItemsPerBatch": 5 + }, + "fieldMappings": [], + "disabled": false + } + } + } +} \ No newline at end of file diff --git a/specification/search/data-plane/Microsoft.Azure.Search.Service/stable/2019-05-06/examples/SearchServiceGetIndexerStatus.json b/specification/search/data-plane/Microsoft.Azure.Search.Service/stable/2019-05-06/examples/SearchServiceGetIndexerStatus.json new file mode 100644 index 000000000000..326f86c3ed3e --- /dev/null +++ b/specification/search/data-plane/Microsoft.Azure.Search.Service/stable/2019-05-06/examples/SearchServiceGetIndexerStatus.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "searchServiceName": "myservice", + "searchDnsSuffix": "search.windows.net", + "indexerName": "myindexer", + "api-version": "2019-05-06" + }, + "responses": { + "200": { + "body": { + "status": "running", + "lastResult": { + "status": "success", + "errorMessage": null, + "startTime": "2014-11-26T03:37:18.853Z", + "endTime": "2014-11-26T03:37:19.012Z", + "errors": [], + "warnings": [], + "itemsProcessed": 11, + "itemsFailed": 0, + "initialTrackingState": null, + "finalTrackingState": null + }, + "executionHistory": [ + { + "status": "success", + "errorMessage": null, + "startTime": "2014-11-26T03:37:18.853Z", + "endTime": "2014-11-26T03:37:19.012Z", + "errors": [], + "warnings": [], + "itemsProcessed": 11, + "itemsFailed": 0, + "initialTrackingState": null, + "finalTrackingState": null + }, + { + "status": "transientFailure", + "errorMessage": null, + "startTime": "2014-11-26T03:28:10.125Z", + "endTime": "2014-11-26T03:28:12.007Z", + "errors": [ + { + "key": "", + "errorMessage": "Document key cannot be missing or empty.", + "statusCode": 400 + } + ], + "warnings": [ + { + "key": "document id", + "message": "A warning doesn't stop indexing, and is intended to inform you of certain interesting situations, like when a blob indexer truncates the amount of text extracted from a blob." + } + ], + "itemsProcessed": 1, + "itemsFailed": 1, + "initialTrackingState": null, + "finalTrackingState": null + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/search/data-plane/Microsoft.Azure.Search.Service/stable/2019-05-06/examples/SearchServiceGetServiceStatistics.json b/specification/search/data-plane/Microsoft.Azure.Search.Service/stable/2019-05-06/examples/SearchServiceGetServiceStatistics.json new file mode 100644 index 000000000000..1a985a743025 --- /dev/null +++ b/specification/search/data-plane/Microsoft.Azure.Search.Service/stable/2019-05-06/examples/SearchServiceGetServiceStatistics.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "searchServiceName": "myservice", + "searchDnsSuffix": "search.windows.net", + "api-version": "2019-05-06" + }, + "responses": { + "200": { + "body": { + "counters": { + "documentCount": { + "usage": 7093, + "quota": 10000 + }, + "indexesCount": { + "usage": 3, + "quota": 3 + }, + "indexersCount": { + "usage": 3, + "quota": 3 + }, + "dataSourcesCount": { + "usage": 1, + "quota": 3 + }, + "storageSize": { + "usage": 914529, + "quota": 52428800 + }, + "synonymMaps": { + "usage": 2, + "quota": 3 + } + }, + "limits": { + "maxFieldsPerIndex": 1000, + "maxFieldNestingDepthPerIndex": 10, + "maxComplexCollectionFieldsPerIndex": 100 + } + } + } + } +} \ No newline at end of file diff --git a/specification/search/data-plane/Microsoft.Azure.Search.Service/stable/2019-05-06/examples/SearchServiceGetSkillset.json b/specification/search/data-plane/Microsoft.Azure.Search.Service/stable/2019-05-06/examples/SearchServiceGetSkillset.json new file mode 100644 index 000000000000..eaa96e51146b --- /dev/null +++ b/specification/search/data-plane/Microsoft.Azure.Search.Service/stable/2019-05-06/examples/SearchServiceGetSkillset.json @@ -0,0 +1,104 @@ +{ + "parameters": { + "searchServiceName": "myservice", + "searchDnsSuffix": "search.windows.net", + "skillsetName": "demoskillset", + "api-version": "2019-05-06" + }, + "responses": { + "200": { + "body": { + "name": "demoskillset", + "description": "Extract entities, detect language and extract key-phrases", + "skills": [ + { + "@odata.type": "#Microsoft.Skills.Text.EntityRecognitionSkill", + "description": null, + "context": null, + "inputs": [ + { + "name": "text", + "source": "/document/content" + } + ], + "outputs": [ + { + "name": "organizations", + "targetName": "organizations" + } + ], + "categories": [ + "organization" + ], + "defaultLanguageCode": "en", + "minimumPrecision": 0.7 + }, + { + "@odata.type": "#Microsoft.Skills.Text.LanguageDetectionSkill", + "description": null, + "context": null, + "inputs": [ + { + "name": "text", + "source": "/document/content" + } + ], + "outputs": [ + { + "name": "languageCode", + "targetName": "languageCode" + } + ] + }, + { + "@odata.type": "#Microsoft.Skills.Text.SplitSkill", + "description": null, + "context": null, + "inputs": [ + { + "name": "text", + "source": "/document/content" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "textItems", + "targetName": "pages" + } + ], + "defaultLanguageCode": null, + "textSplitMode": "pages", + "maximumPageLength": 4000 + }, + { + "@odata.type": "#Microsoft.Skills.Text.KeyPhraseExtractionSkill", + "description": null, + "context": "/document/pages/*", + "inputs": [ + { + "name": "text", + "source": "/document/pages/*" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "keyPhrases", + "targetName": "keyPhrases" + } + ], + "defaultLanguageCode": null, + "maxKeyPhraseCount": null + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/search/data-plane/Microsoft.Azure.Search.Service/stable/2019-05-06/examples/SearchServiceGetSynonymMap.json b/specification/search/data-plane/Microsoft.Azure.Search.Service/stable/2019-05-06/examples/SearchServiceGetSynonymMap.json new file mode 100644 index 000000000000..8b19433c1514 --- /dev/null +++ b/specification/search/data-plane/Microsoft.Azure.Search.Service/stable/2019-05-06/examples/SearchServiceGetSynonymMap.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "searchServiceName": "myservice", + "searchDnsSuffix": "search.windows.net", + "synonymMapName": "mysynonymmap", + "api-version": "2019-05-06" + }, + "responses": { + "200": { + "body": { + "name": "mysynonymmap", + "format": "solr", + "synonyms": "United States, United States of America, USA\nWashington, Wash. => WA" + } + } + } +} \ No newline at end of file diff --git a/specification/search/data-plane/Microsoft.Azure.Search.Service/stable/2019-05-06/examples/SearchServiceIndexAnalyze.json b/specification/search/data-plane/Microsoft.Azure.Search.Service/stable/2019-05-06/examples/SearchServiceIndexAnalyze.json new file mode 100644 index 000000000000..65c0a84f6adb --- /dev/null +++ b/specification/search/data-plane/Microsoft.Azure.Search.Service/stable/2019-05-06/examples/SearchServiceIndexAnalyze.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "searchServiceName": "myservice", + "searchDnsSuffix": "search.windows.net", + "indexName": "hotels", + "api-version": "2019-05-06", + "request": { + "text": "Text to analyze", + "analyzer": "standard.lucene" + } + }, + "responses": { + "200": { + "body": { + "tokens": [ + { + "token": "text", + "startOffset": 0, + "endOffset": 4, + "position": 0 + }, + { + "token": "to", + "startOffset": 5, + "endOffset": 7, + "position": 1 + }, + { + "token": "analyze", + "startOffset": 8, + "endOffset": 15, + "position": 2 + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/search/data-plane/Microsoft.Azure.Search.Service/stable/2019-05-06/examples/SearchServiceListDataSources.json b/specification/search/data-plane/Microsoft.Azure.Search.Service/stable/2019-05-06/examples/SearchServiceListDataSources.json new file mode 100644 index 000000000000..ace244260b08 --- /dev/null +++ b/specification/search/data-plane/Microsoft.Azure.Search.Service/stable/2019-05-06/examples/SearchServiceListDataSources.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "searchServiceName": "myservice", + "searchDnsSuffix": "search.windows.net", + "api-version": "2019-05-06" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "mydocdbdatasource", + "description": "My Cosmos DB data source.", + "type": "cosmosdb", + "credentials": { + "connectionString": null + }, + "container": { + "name": "myDocDbCollectionId", + "query": "SELECT c.id, c.userId, tag, c._ts FROM c JOIN tag IN c.tags WHERE c._ts >= @HighWaterMark ORDER BY c._ts" + }, + "dataChangeDetectionPolicy": { + "@odata.type": "#Microsoft.Azure.Search.HighWaterMarkChangeDetectionPolicy", + "highWaterMarkColumnName": "_ts" + }, + "dataDeletionDetectionPolicy": { + "@odata.type": "#Microsoft.Azure.Search.SoftDeleteColumnDeletionDetectionPolicy", + "softDeleteColumnName": "isDeleted", + "softDeleteMarkerValue": "true" + } + }, + { + "name": "myblobdatasource", + "description": "My Azure Blob data source.", + "type": "azureblob", + "credentials": { + "connectionString": null + }, + "container": { + "name": "mycontainer" + }, + "dataChangeDetectionPolicy": null, + "dataDeletionDetectionPolicy": null + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/search/data-plane/Microsoft.Azure.Search.Service/stable/2019-05-06/examples/SearchServiceListIndexers.json b/specification/search/data-plane/Microsoft.Azure.Search.Service/stable/2019-05-06/examples/SearchServiceListIndexers.json new file mode 100644 index 000000000000..47c683ac31bb --- /dev/null +++ b/specification/search/data-plane/Microsoft.Azure.Search.Service/stable/2019-05-06/examples/SearchServiceListIndexers.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "searchServiceName": "myservice", + "searchDnsSuffix": "search.windows.net", + "api-version": "2019-05-06" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "myindexer", + "description": "a cool indexer", + "dataSourceName": "mydocdbdatasource", + "targetIndexName": "orders", + "schedule": { + "interval": "PT1H", + "startTime": "2015-01-01T00:00:00Z" + }, + "parameters": { + "maxFailedItems": 10, + "maxFailedItemsPerBatch": 5 + }, + "fieldMappings": [], + "disabled": false + }, + { + "name": "myotherindexer", + "description": "another cool indexer", + "dataSourceName": "myblobdatasource", + "targetIndexName": "orders", + "parameters": { + "maxFailedItems": 10, + "maxFailedItemsPerBatch": 5, + "batchSize": 15 + }, + "fieldMappings": [ + { + "sourceFieldName": "PersonName", + "targetFieldName": "FirstName", + "mappingFunction": { + "name": "extractTokenAtPosition", + "parameters": { + "delimiter": " ", + "position": 0 + } + } + }, + { + "sourceFieldName": "PersonName", + "targetFieldName": "LastName", + "mappingFunction": { + "name": "extractTokenAtPosition", + "parameters": { + "delimiter": " ", + "position": 1 + } + } + } + ], + "disabled": false + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/search/data-plane/Microsoft.Azure.Search.Service/stable/2019-05-06/examples/SearchServiceListIndexes.json b/specification/search/data-plane/Microsoft.Azure.Search.Service/stable/2019-05-06/examples/SearchServiceListIndexes.json new file mode 100644 index 000000000000..989a900f9b50 --- /dev/null +++ b/specification/search/data-plane/Microsoft.Azure.Search.Service/stable/2019-05-06/examples/SearchServiceListIndexes.json @@ -0,0 +1,281 @@ +{ + "parameters": { + "searchServiceName": "myservice", + "searchDnsSuffix": "search.windows.net", + "$select": "name", + "api-version": "2019-05-06" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "hotels", + "fields": [ + { + "name": "hotelId", + "type": "Edm.String", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": true, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "baseRate", + "type": "Edm.Double", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "description", + "type": "Edm.String", + "searchable": true, + "filterable": false, + "retrievable": true, + "sortable": false, + "facetable": false, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "description_fr", + "type": "Edm.String", + "searchable": true, + "filterable": false, + "retrievable": true, + "sortable": false, + "facetable": false, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": "fr.lucene", + "synonymMaps": [] + }, + { + "name": "hotelName", + "type": "Edm.String", + "searchable": true, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "category", + "type": "Edm.String", + "searchable": true, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "tags", + "type": "Collection(Edm.String)", + "searchable": true, + "filterable": true, + "retrievable": true, + "sortable": false, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": "tagsAnalyzer", + "synonymMaps": [] + }, + { + "name": "parkingIncluded", + "type": "Edm.Boolean", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "smokingAllowed", + "type": "Edm.Boolean", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "lastRenovationDate", + "type": "Edm.DateTimeOffset", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "rating", + "type": "Edm.Int32", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "location", + "type": "Edm.GeographyPoint", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": false, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + } + ], + "scoringProfiles": [ + { + "name": "geo", + "text": { + "weights": { + "hotelName": 5 + } + }, + "functions": [ + { + "type": "distance", + "boost": 5, + "fieldName": "location", + "interpolation": "logarithmic", + "distance": { + "referencePointParameter": "currentLocation", + "boostingDistance": 10 + } + } + ] + } + ], + "defaultScoringProfile": "geo", + "suggesters": [ + { + "name": "sg", + "searchMode": "analyzingInfixMatching", + "sourceFields": [ + "hotelName" + ] + } + ], + "analyzers": [ + { + "name": "tagsAnalyzer", + "@odata.type": "#Microsoft.Azure.Search.CustomAnalyzer", + "charFilters": [ + "html_strip" + ], + "tokenizer": "standard_v2" + } + ], + "tokenizers": [], + "tokenFilters": [], + "charFilters": [], + "corsOptions": { + "allowedOrigins": [ + "tempuri.org" + ], + "maxAgeInSeconds": 60 + } + }, + { + "name": "testindex", + "fields": [ + { + "name": "id", + "type": "Edm.String", + "searchable": false, + "filterable": false, + "retrievable": true, + "sortable": false, + "facetable": false, + "key": true, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "hidden", + "type": "Edm.Double", + "searchable": false, + "filterable": true, + "retrievable": false, + "sortable": true, + "facetable": false, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + } + ], + "scoringProfiles": [], + "defaultScoringProfile": null, + "suggesters": [], + "analyzers": [], + "tokenizers": [], + "tokenFilters": [], + "charFilters": [], + "corsOptions": null + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/search/data-plane/Microsoft.Azure.Search.Service/stable/2019-05-06/examples/SearchServiceListSkillsets.json b/specification/search/data-plane/Microsoft.Azure.Search.Service/stable/2019-05-06/examples/SearchServiceListSkillsets.json new file mode 100644 index 000000000000..c34f254df26f --- /dev/null +++ b/specification/search/data-plane/Microsoft.Azure.Search.Service/stable/2019-05-06/examples/SearchServiceListSkillsets.json @@ -0,0 +1,107 @@ +{ + "parameters": { + "searchServiceName": "myservice", + "searchDnsSuffix": "search.windows.net", + "api-version": "2019-05-06" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "demoskillset", + "description": "Extract entities, detect language and extract key-phrases", + "skills": [ + { + "@odata.type": "#Microsoft.Skills.Text.EntityRecognitionSkill", + "description": null, + "context": null, + "inputs": [ + { + "name": "text", + "source": "/document/content" + } + ], + "outputs": [ + { + "name": "organizations", + "targetName": "organizations" + } + ], + "categories": [ + "organization" + ], + "defaultLanguageCode": "en", + "minimumPrecision": 0.7 + }, + { + "@odata.type": "#Microsoft.Skills.Text.LanguageDetectionSkill", + "description": null, + "context": null, + "inputs": [ + { + "name": "text", + "source": "/document/content" + } + ], + "outputs": [ + { + "name": "languageCode", + "targetName": "languageCode" + } + ] + }, + { + "@odata.type": "#Microsoft.Skills.Text.SplitSkill", + "description": null, + "context": null, + "inputs": [ + { + "name": "text", + "source": "/document/content" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "textItems", + "targetName": "pages" + } + ], + "defaultLanguageCode": null, + "textSplitMode": "pages", + "maximumPageLength": 4000 + }, + { + "@odata.type": "#Microsoft.Skills.Text.KeyPhraseExtractionSkill", + "description": null, + "context": "/document/pages/*", + "inputs": [ + { + "name": "text", + "source": "/document/pages/*" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "keyPhrases", + "targetName": "keyPhrases" + } + ], + "defaultLanguageCode": null, + "maxKeyPhraseCount": null + } + ] + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/search/data-plane/Microsoft.Azure.Search.Service/stable/2019-05-06/examples/SearchServiceListSynonymMaps.json b/specification/search/data-plane/Microsoft.Azure.Search.Service/stable/2019-05-06/examples/SearchServiceListSynonymMaps.json new file mode 100644 index 000000000000..2e35aa4343a5 --- /dev/null +++ b/specification/search/data-plane/Microsoft.Azure.Search.Service/stable/2019-05-06/examples/SearchServiceListSynonymMaps.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "searchServiceName": "myservice", + "searchDnsSuffix": "search.windows.net", + "api-version": "2019-05-06" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "mysynonymmap", + "format": "solr", + "synonyms": "United States, United States of America, USA\nWashington, Wash. => WA" + }, + { + "name": "myothersynonymmap", + "format": "solr", + "synonyms": "couch, sofa, chesterfield\npop, soda\ntoque, hat" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/search/data-plane/Microsoft.Azure.Search.Service/stable/2019-05-06/examples/SearchServiceResetIndexer.json b/specification/search/data-plane/Microsoft.Azure.Search.Service/stable/2019-05-06/examples/SearchServiceResetIndexer.json new file mode 100644 index 000000000000..afdef3ddb709 --- /dev/null +++ b/specification/search/data-plane/Microsoft.Azure.Search.Service/stable/2019-05-06/examples/SearchServiceResetIndexer.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "searchServiceName": "myservice", + "searchDnsSuffix": "search.windows.net", + "indexerName": "myindexer", + "api-version": "2019-05-06" + }, + "responses": { + "204": {} + } +} \ No newline at end of file diff --git a/specification/search/data-plane/Microsoft.Azure.Search.Service/stable/2019-05-06/examples/SearchServiceRunIndexer.json b/specification/search/data-plane/Microsoft.Azure.Search.Service/stable/2019-05-06/examples/SearchServiceRunIndexer.json new file mode 100644 index 000000000000..8522aecdcf49 --- /dev/null +++ b/specification/search/data-plane/Microsoft.Azure.Search.Service/stable/2019-05-06/examples/SearchServiceRunIndexer.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "searchServiceName": "myservice", + "searchDnsSuffix": "search.windows.net", + "indexerName": "myindexer", + "api-version": "2019-05-06" + }, + "responses": { + "202": {} + } +} \ No newline at end of file diff --git a/specification/search/data-plane/Microsoft.Azure.Search.Service/stable/2019-05-06/searchservice.json b/specification/search/data-plane/Microsoft.Azure.Search.Service/stable/2019-05-06/searchservice.json new file mode 100644 index 000000000000..cbfcdecbb2b7 --- /dev/null +++ b/specification/search/data-plane/Microsoft.Azure.Search.Service/stable/2019-05-06/searchservice.json @@ -0,0 +1,5362 @@ +{ + "swagger": "2.0", + "info": { + "title": "SearchServiceClient", + "description": "Client that can be used to manage and query indexes and documents, as well as manage other resources, on an Azure Search service.", + "version": "2019-05-06", + "x-ms-code-generation-settings": { + "useDateTimeOffset": true + } + }, + "x-ms-parameterized-host": { + "hostTemplate": "https://{searchServiceName}.{searchDnsSuffix}", + "useSchemePrefix": false, + "parameters": [ + { + "$ref": "#/parameters/SearchServiceNameParameter" + }, + { + "$ref": "#/parameters/SearchDnsSuffixParameter" + } + ] + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/datasources('{dataSourceName}')": { + "put": { + "tags": [ + "DataSources" + ], + "operationId": "DataSources_CreateOrUpdate", + "x-ms-examples": { + "SearchServiceCreateOrUpdateDataSource": { + "$ref": "./examples/SearchServiceCreateOrUpdateDataSource.json" + } + }, + "description": "Creates a new Azure Search datasource or updates a datasource if it already exists.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Update-Data-Source" + }, + "parameters": [ + { + "name": "dataSourceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the datasource to create or update." + }, + { + "name": "dataSource", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DataSource" + }, + "description": "The definition of the datasource to create or update." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + }, + { + "$ref": "#/parameters/IfNoneMatchParameter" + }, + { + "$ref": "#/parameters/PreferHeaderParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/DataSource" + } + }, + "201": { + "description": "", + "schema": { + "$ref": "#/definitions/DataSource" + } + } + } + }, + "delete": { + "tags": [ + "DataSources" + ], + "operationId": "DataSources_Delete", + "x-ms-examples": { + "SearchServiceDeleteDataSource": { + "$ref": "./examples/SearchServiceDeleteDataSource.json" + } + }, + "description": "Deletes an Azure Search datasource.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Delete-Data-Source" + }, + "parameters": [ + { + "name": "dataSourceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the datasource to delete." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + }, + { + "$ref": "#/parameters/IfNoneMatchParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "204": { + "description": "" + }, + "404": { + "description": "" + } + } + }, + "get": { + "tags": [ + "DataSources" + ], + "operationId": "DataSources_Get", + "x-ms-examples": { + "SearchServiceGetDataSource": { + "$ref": "./examples/SearchServiceGetDataSource.json" + } + }, + "description": "Retrieves a datasource definition from Azure Search.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Get-Data-Source" + }, + "parameters": [ + { + "name": "dataSourceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the datasource to retrieve." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/DataSource" + } + } + } + } + }, + "/datasources": { + "get": { + "tags": [ + "DataSources" + ], + "operationId": "DataSources_List", + "x-ms-examples": { + "SearchServiceListDataSources": { + "$ref": "./examples/SearchServiceListDataSources.json" + } + }, + "description": "Lists all datasources available for an Azure Search service.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/List-Data-Sources" + }, + "parameters": [ + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/DataSourceListResult" + } + } + } + }, + "post": { + "tags": [ + "DataSources" + ], + "operationId": "DataSources_Create", + "x-ms-examples": { + "SearchServiceCreateDataSource": { + "$ref": "./examples/SearchServiceCreateDataSource.json" + } + }, + "description": "Creates a new Azure Search datasource.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Create-Data-Source" + }, + "parameters": [ + { + "name": "dataSource", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DataSource" + }, + "description": "The definition of the datasource to create." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "201": { + "description": "", + "schema": { + "$ref": "#/definitions/DataSource" + } + } + } + } + }, + "/indexers('{indexerName}')/search.reset": { + "post": { + "tags": [ + "Indexers" + ], + "operationId": "Indexers_Reset", + "x-ms-examples": { + "SearchServiceResetIndexer": { + "$ref": "./examples/SearchServiceResetIndexer.json" + } + }, + "description": "Resets the change tracking state associated with an Azure Search indexer.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Reset-Indexer" + }, + "parameters": [ + { + "name": "indexerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the indexer to reset." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "204": { + "description": "" + } + } + } + }, + "/indexers('{indexerName}')/search.run": { + "post": { + "tags": [ + "Indexers" + ], + "operationId": "Indexers_Run", + "x-ms-examples": { + "SearchServiceRunIndexer": { + "$ref": "./examples/SearchServiceRunIndexer.json" + } + }, + "description": "Runs an Azure Search indexer on-demand.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Run-Indexer" + }, + "parameters": [ + { + "name": "indexerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the indexer to run." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "202": { + "description": "" + } + } + } + }, + "/indexers('{indexerName}')": { + "put": { + "tags": [ + "Indexers" + ], + "operationId": "Indexers_CreateOrUpdate", + "x-ms-examples": { + "SearchServiceCreateOrUpdateIndexer": { + "$ref": "./examples/SearchServiceCreateOrUpdateIndexer.json" + } + }, + "description": "Creates a new Azure Search indexer or updates an indexer if it already exists.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Create-Indexer" + }, + "parameters": [ + { + "name": "indexerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the indexer to create or update." + }, + { + "name": "indexer", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Indexer" + }, + "description": "The definition of the indexer to create or update." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + }, + { + "$ref": "#/parameters/IfNoneMatchParameter" + }, + { + "$ref": "#/parameters/PreferHeaderParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "201": { + "description": "", + "schema": { + "$ref": "#/definitions/Indexer" + } + }, + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/Indexer" + } + } + } + }, + "delete": { + "tags": [ + "Indexers" + ], + "operationId": "Indexers_Delete", + "x-ms-examples": { + "SearchServiceDeleteIndexer": { + "$ref": "./examples/SearchServiceDeleteIndexer.json" + } + }, + "description": "Deletes an Azure Search indexer.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Delete-Indexer" + }, + "parameters": [ + { + "name": "indexerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the indexer to delete." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + }, + { + "$ref": "#/parameters/IfNoneMatchParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "404": { + "description": "" + }, + "204": { + "description": "" + } + } + }, + "get": { + "tags": [ + "Indexers" + ], + "operationId": "Indexers_Get", + "x-ms-examples": { + "SearchServiceGetIndexer": { + "$ref": "./examples/SearchServiceGetIndexer.json" + } + }, + "description": "Retrieves an indexer definition from Azure Search.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Get-Indexer" + }, + "parameters": [ + { + "name": "indexerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the indexer to retrieve." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/Indexer" + } + } + } + } + }, + "/indexers": { + "get": { + "tags": [ + "Indexers" + ], + "operationId": "Indexers_List", + "x-ms-examples": { + "SearchServiceListIndexers": { + "$ref": "./examples/SearchServiceListIndexers.json" + } + }, + "description": "Lists all indexers available for an Azure Search service.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/List-Indexers" + }, + "parameters": [ + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/IndexerListResult" + } + } + } + }, + "post": { + "tags": [ + "Indexers" + ], + "operationId": "Indexers_Create", + "x-ms-examples": { + "SearchServiceCreateIndexer": { + "$ref": "./examples/SearchServiceCreateIndexer.json" + } + }, + "description": "Creates a new Azure Search indexer.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Create-Indexer" + }, + "parameters": [ + { + "name": "indexer", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Indexer" + }, + "description": "The definition of the indexer to create." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "201": { + "description": "", + "schema": { + "$ref": "#/definitions/Indexer" + } + } + } + } + }, + "/indexers('{indexerName}')/search.status": { + "get": { + "tags": [ + "Indexers" + ], + "operationId": "Indexers_GetStatus", + "x-ms-examples": { + "SearchServiceGetIndexerStatus": { + "$ref": "./examples/SearchServiceGetIndexerStatus.json" + } + }, + "description": "Returns the current status and execution history of an indexer.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Get-Indexer-Status" + }, + "parameters": [ + { + "name": "indexerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the indexer for which to retrieve status." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/IndexerExecutionInfo" + } + } + } + } + }, + "/skillsets('{skillsetName}')": { + "put": { + "tags": [ + "Skillsets" + ], + "operationId": "Skillsets_CreateOrUpdate", + "x-ms-examples": { + "SearchServiceCreateOrUpdateSkillset": { + "$ref": "./examples/SearchServiceCreateOrUpdateSkillset.json" + } + }, + "description": "Creates a new cognitive skillset in an Azure Search service or updates the skillset if it already exists.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/update-skillset" + }, + "parameters": [ + { + "name": "skillsetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the skillset to create or update." + }, + { + "name": "skillset", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Skillset" + }, + "description": "The skillset containing one or more cognitive skills to create or update in an Azure Search service." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/PreferHeaderParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "The skillset is successfully updated.", + "schema": { + "$ref": "#/definitions/Skillset" + } + }, + "201": { + "description": "The skillset is successfully created.", + "schema": { + "$ref": "#/definitions/Skillset" + } + } + } + }, + "delete": { + "tags": [ + "Skillsets" + ], + "operationId": "Skillsets_Delete", + "x-ms-examples": { + "SearchServiceDeleteSkillset": { + "$ref": "./examples/SearchServiceDeleteSkillset.json" + } + }, + "description": "Deletes a cognitive skillset in an Azure Search service.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/delete-skillset" + }, + "parameters": [ + { + "name": "skillsetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the skillset to delete." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "204": { + "description": "The skillset is successfully deleted." + }, + "404": { + "description": "The provided skillset name is not found." + } + } + }, + "get": { + "tags": [ + "Skillsets" + ], + "operationId": "Skillsets_Get", + "x-ms-examples": { + "SearchServiceGetSkillset": { + "$ref": "./examples/SearchServiceGetSkillset.json" + } + }, + "description": "Retrieves a cognitive skillset in an Azure Search service.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/get-skillset" + }, + "parameters": [ + { + "name": "skillsetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the skillset to retrieve." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "The skillset is successfully returned.", + "schema": { + "$ref": "#/definitions/Skillset" + } + } + } + } + }, + "/skillsets": { + "get": { + "tags": [ + "Skillsets" + ], + "operationId": "Skillsets_List", + "x-ms-examples": { + "SearchServiceListSkillsets": { + "$ref": "./examples/SearchServiceListSkillsets.json" + } + }, + "description": "List all cognitive skillsets in an Azure Search service.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/list-skillset" + }, + "parameters": [ + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "The list is successfully returned.", + "schema": { + "$ref": "#/definitions/SkillsetListResult" + } + } + } + }, + "post": { + "tags": [ + "Skillsets" + ], + "operationId": "Skillsets_Create", + "x-ms-examples": { + "SearchServiceCreateSkillset": { + "$ref": "./examples/SearchServiceCreateSkillset.json" + } + }, + "description": "Creates a new cognitive skillset in an Azure Search service.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/create-skillset" + }, + "parameters": [ + { + "name": "skillset", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Skillset" + }, + "description": "The skillset containing one or more cognitive skills to create in an Azure Search service." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "201": { + "description": "The skillset is successfully created.", + "schema": { + "$ref": "#/definitions/Skillset" + } + } + } + } + }, + "/synonymmaps('{synonymMapName}')": { + "put": { + "tags": [ + "SynonymMaps" + ], + "operationId": "SynonymMaps_CreateOrUpdate", + "x-ms-examples": { + "SearchServiceCreateOrUpdateSynonymMap": { + "$ref": "./examples/SearchServiceCreateOrUpdateSynonymMap.json" + } + }, + "description": "Creates a new Azure Search synonym map or updates a synonym map if it already exists.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Update-Synonym-Map" + }, + "parameters": [ + { + "name": "synonymMapName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the synonym map to create or update." + }, + { + "name": "synonymMap", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SynonymMap" + }, + "description": "The definition of the synonym map to create or update." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + }, + { + "$ref": "#/parameters/IfNoneMatchParameter" + }, + { + "$ref": "#/parameters/PreferHeaderParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/SynonymMap" + } + }, + "201": { + "description": "", + "schema": { + "$ref": "#/definitions/SynonymMap" + } + } + } + }, + "delete": { + "tags": [ + "SynonymMaps" + ], + "operationId": "SynonymMaps_Delete", + "x-ms-examples": { + "SearchServiceDeleteSynonymMap": { + "$ref": "./examples/SearchServiceDeleteSynonymMap.json" + } + }, + "description": "Deletes an Azure Search synonym map.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Delete-Synonym-Map" + }, + "parameters": [ + { + "name": "synonymMapName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the synonym map to delete." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + }, + { + "$ref": "#/parameters/IfNoneMatchParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "204": { + "description": "" + }, + "404": { + "description": "" + } + } + }, + "get": { + "tags": [ + "SynonymMaps" + ], + "operationId": "SynonymMaps_Get", + "x-ms-examples": { + "SearchServiceGetSynonymMap": { + "$ref": "./examples/SearchServiceGetSynonymMap.json" + } + }, + "description": "Retrieves a synonym map definition from Azure Search.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Get-Synonym-Map" + }, + "parameters": [ + { + "name": "synonymMapName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the synonym map to retrieve." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/SynonymMap" + } + } + } + } + }, + "/synonymmaps": { + "get": { + "tags": [ + "SynonymMaps" + ], + "operationId": "SynonymMaps_List", + "x-ms-examples": { + "SearchServiceListSynonymMaps": { + "$ref": "./examples/SearchServiceListSynonymMaps.json" + } + }, + "description": "Lists all synonym maps available for an Azure Search service.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/List-Synonym-Maps" + }, + "parameters": [ + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/SynonymMapListResult" + } + } + } + }, + "post": { + "tags": [ + "SynonymMaps" + ], + "operationId": "SynonymMaps_Create", + "x-ms-examples": { + "SearchServiceCreateSynonymMap": { + "$ref": "./examples/SearchServiceCreateSynonymMap.json" + } + }, + "description": "Creates a new Azure Search synonym map.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Create-Synonym-Map" + }, + "parameters": [ + { + "name": "synonymMap", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SynonymMap" + }, + "description": "The definition of the synonym map to create." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "201": { + "description": "", + "schema": { + "$ref": "#/definitions/SynonymMap" + } + } + } + } + }, + "/indexes": { + "post": { + "tags": [ + "Indexes" + ], + "operationId": "Indexes_Create", + "x-ms-examples": { + "SearchServiceCreateIndex": { + "$ref": "./examples/SearchServiceCreateIndex.json" + } + }, + "description": "Creates a new Azure Search index.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Create-Index" + }, + "parameters": [ + { + "name": "index", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Index" + }, + "description": "The definition of the index to create." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "201": { + "description": "", + "schema": { + "$ref": "#/definitions/Index" + } + } + } + }, + "get": { + "tags": [ + "Indexes" + ], + "operationId": "Indexes_List", + "x-ms-examples": { + "SearchServiceListIndexes": { + "$ref": "./examples/SearchServiceListIndexes.json" + } + }, + "description": "Lists all indexes available for an Azure Search service.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/List-Indexes" + }, + "parameters": [ + { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "Selects which properties of the index definitions to retrieve. Specified as a comma-separated list of JSON property names, or '*' for all properties. The default is all properties." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/IndexListResult" + } + } + } + } + }, + "/indexes('{indexName}')": { + "put": { + "tags": [ + "Indexes" + ], + "operationId": "Indexes_CreateOrUpdate", + "x-ms-examples": { + "SearchServiceCreateOrUpdateIndex": { + "$ref": "./examples/SearchServiceCreateOrUpdateIndex.json" + } + }, + "description": "Creates a new Azure Search index or updates an index if it already exists.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Update-Index" + }, + "parameters": [ + { + "name": "indexName", + "in": "path", + "required": true, + "type": "string", + "description": "The definition of the index to create or update." + }, + { + "name": "index", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Index" + }, + "description": "The definition of the index to create or update." + }, + { + "name": "allowIndexDowntime", + "in": "query", + "required": false, + "type": "boolean", + "description": "Allows new analyzers, tokenizers, token filters, or char filters to be added to an index by taking the index offline for at least a few seconds. This temporarily causes indexing and query requests to fail. Performance and write availability of the index can be impaired for several minutes after the index is updated, or longer for very large indexes." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + }, + { + "$ref": "#/parameters/IfNoneMatchParameter" + }, + { + "$ref": "#/parameters/PreferHeaderParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/Index" + } + }, + "201": { + "description": "", + "schema": { + "$ref": "#/definitions/Index" + } + } + } + }, + "delete": { + "tags": [ + "Indexes" + ], + "operationId": "Indexes_Delete", + "x-ms-examples": { + "SearchServiceDeleteIndex": { + "$ref": "./examples/SearchServiceDeleteIndex.json" + } + }, + "description": "Deletes an Azure Search index and all the documents it contains.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Delete-Index" + }, + "parameters": [ + { + "name": "indexName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the index to delete." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + }, + { + "$ref": "#/parameters/IfNoneMatchParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "204": { + "description": "" + }, + "404": { + "description": "" + } + } + }, + "get": { + "tags": [ + "Indexes" + ], + "operationId": "Indexes_Get", + "x-ms-examples": { + "SearchServiceGetIndex": { + "$ref": "./examples/SearchServiceGetIndex.json" + } + }, + "description": "Retrieves an index definition from Azure Search.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Get-Index" + }, + "parameters": [ + { + "name": "indexName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the index to retrieve." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/Index" + } + } + } + } + }, + "/indexes('{indexName}')/search.stats": { + "get": { + "tags": [ + "Indexes" + ], + "operationId": "Indexes_GetStatistics", + "x-ms-examples": { + "SearchServiceGetIndexStatistics": { + "$ref": "./examples/SearchServiceGetIndexStatistics.json" + } + }, + "description": "Returns statistics for the given index, including a document count and storage usage.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Get-Index-Statistics" + }, + "parameters": [ + { + "name": "indexName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the index for which to retrieve statistics." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/IndexGetStatisticsResult" + } + } + } + } + }, + "/indexes('{indexName}')/search.analyze": { + "post": { + "tags": [ + "Indexes" + ], + "operationId": "Indexes_Analyze", + "x-ms-examples": { + "SearchServiceIndexAnalyze": { + "$ref": "./examples/SearchServiceIndexAnalyze.json" + } + }, + "description": "Shows how an analyzer breaks text into tokens.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/test-analyzer" + }, + "parameters": [ + { + "name": "indexName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the index for which to test an analyzer." + }, + { + "name": "request", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AnalyzeRequest" + }, + "description": "The text and analyzer or analysis components to test." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/AnalyzeResult" + } + } + } + } + }, + "/servicestats": { + "get": { + "tags": [ + "Service" + ], + "operationId": "GetServiceStatistics", + "x-ms-examples": { + "SearchServiceGetServiceStatistics": { + "$ref": "./examples/SearchServiceGetServiceStatistics.json" + } + }, + "description": "Gets service level statistics for an Azure Search service.", + "parameters": [ + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/ServiceStatistics" + } + } + } + } + } + }, + "definitions": { + "AnalyzeRequest": { + "properties": { + "text": { + "type": "string", + "description": "The text to break into tokens." + }, + "analyzer": { + "$ref": "#/definitions/AnalyzerName", + "description": "The name of the analyzer to use to break the given text. If this parameter is not specified, you must specify a tokenizer instead. The tokenizer and analyzer parameters are mutually exclusive." + }, + "tokenizer": { + "$ref": "#/definitions/TokenizerName", + "description": "The name of the tokenizer to use to break the given text. If this parameter is not specified, you must specify an analyzer instead. The tokenizer and analyzer parameters are mutually exclusive." + }, + "tokenFilters": { + "type": "array", + "items": { + "$ref": "#/definitions/TokenFilterName", + "x-nullable": false + }, + "description": "An optional list of token filters to use when breaking the given text. This parameter can only be set when using the tokenizer parameter." + }, + "charFilters": { + "type": "array", + "items": { + "$ref": "#/definitions/CharFilterName", + "x-nullable": false + }, + "description": "An optional list of character filters to use when breaking the given text. This parameter can only be set when using the tokenizer parameter." + } + }, + "required": [ + "text" + ], + "description": "Specifies some text and analysis components used to break that text into tokens." + }, + "AnalyzeResult": { + "properties": { + "tokens": { + "type": "array", + "items": { + "$ref": "#/definitions/TokenInfo" + }, + "description": "The list of tokens returned by the analyzer specified in the request." + } + }, + "description": "The result of testing an analyzer on text." + }, + "TokenInfo": { + "properties": { + "token": { + "type": "string", + "readOnly": true, + "description": "The token returned by the analyzer." + }, + "startOffset": { + "type": "integer", + "format": "int32", + "readOnly": true, + "description": "The index of the first character of the token in the input text." + }, + "endOffset": { + "type": "integer", + "format": "int32", + "readOnly": true, + "description": "The index of the last character of the token in the input text." + }, + "position": { + "type": "integer", + "format": "int32", + "readOnly": true, + "description": "The position of the token in the input text relative to other tokens. The first token in the input text has position 0, the next has position 1, and so on. Depending on the analyzer used, some tokens might have the same position, for example if they are synonyms of each other." + } + }, + "description": "Information about a token returned by an analyzer." + }, + "AnalyzerName": { + "type": "string", + "enum": [ + "ar.microsoft", + "ar.lucene", + "hy.lucene", + "bn.microsoft", + "eu.lucene", + "bg.microsoft", + "bg.lucene", + "ca.microsoft", + "ca.lucene", + "zh-Hans.microsoft", + "zh-Hans.lucene", + "zh-Hant.microsoft", + "zh-Hant.lucene", + "hr.microsoft", + "cs.microsoft", + "cs.lucene", + "da.microsoft", + "da.lucene", + "nl.microsoft", + "nl.lucene", + "en.microsoft", + "en.lucene", + "et.microsoft", + "fi.microsoft", + "fi.lucene", + "fr.microsoft", + "fr.lucene", + "gl.lucene", + "de.microsoft", + "de.lucene", + "el.microsoft", + "el.lucene", + "gu.microsoft", + "he.microsoft", + "hi.microsoft", + "hi.lucene", + "hu.microsoft", + "hu.lucene", + "is.microsoft", + "id.microsoft", + "id.lucene", + "ga.lucene", + "it.microsoft", + "it.lucene", + "ja.microsoft", + "ja.lucene", + "kn.microsoft", + "ko.microsoft", + "ko.lucene", + "lv.microsoft", + "lv.lucene", + "lt.microsoft", + "ml.microsoft", + "ms.microsoft", + "mr.microsoft", + "nb.microsoft", + "no.lucene", + "fa.lucene", + "pl.microsoft", + "pl.lucene", + "pt-BR.microsoft", + "pt-BR.lucene", + "pt-PT.microsoft", + "pt-PT.lucene", + "pa.microsoft", + "ro.microsoft", + "ro.lucene", + "ru.microsoft", + "ru.lucene", + "sr-cyrillic.microsoft", + "sr-latin.microsoft", + "sk.microsoft", + "sl.microsoft", + "es.microsoft", + "es.lucene", + "sv.microsoft", + "sv.lucene", + "ta.microsoft", + "te.microsoft", + "th.microsoft", + "th.lucene", + "tr.microsoft", + "tr.lucene", + "uk.microsoft", + "ur.microsoft", + "vi.microsoft", + "standard.lucene", + "standardasciifolding.lucene", + "keyword", + "pattern", + "simple", + "stop", + "whitespace" + ], + "x-ms-enum": { + "name": "AnalyzerName", + "modelAsString": false + }, + "description": "Defines the names of all text analyzers supported by Azure Search.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Language-support" + } + }, + "TokenizerName": { + "type": "string", + "enum": [ + "classic", + "edgeNGram", + "keyword_v2", + "letter", + "lowercase", + "microsoft_language_tokenizer", + "microsoft_language_stemming_tokenizer", + "nGram", + "path_hierarchy_v2", + "pattern", + "standard_v2", + "uax_url_email", + "whitespace" + ], + "x-ms-enum": { + "name": "TokenizerName", + "modelAsString": false + }, + "description": "Defines the names of all tokenizers supported by Azure Search.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search" + } + }, + "TokenFilterName": { + "type": "string", + "enum": [ + "arabic_normalization", + "apostrophe", + "asciifolding", + "cjk_bigram", + "cjk_width", + "classic", + "common_grams", + "edgeNGram_v2", + "elision", + "german_normalization", + "hindi_normalization", + "indic_normalization", + "keyword_repeat", + "kstem", + "length", + "limit", + "lowercase", + "nGram_v2", + "persian_normalization", + "phonetic", + "porter_stem", + "reverse", + "scandinavian_normalization", + "scandinavian_folding", + "shingle", + "snowball", + "sorani_normalization", + "stemmer", + "stopwords", + "trim", + "truncate", + "unique", + "uppercase", + "word_delimiter" + ], + "x-ms-enum": { + "name": "TokenFilterName", + "modelAsString": false + }, + "description": "Defines the names of all token filters supported by Azure Search.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search" + } + }, + "CharFilterName": { + "type": "string", + "enum": [ + "html_strip" + ], + "x-ms-enum": { + "name": "CharFilterName", + "modelAsString": false + }, + "description": "Defines the names of all character filters supported by Azure Search.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search" + } + }, + "RegexFlags": { + "type": "string", + "enum": [ + "CANON_EQ", + "CASE_INSENSITIVE", + "COMMENTS", + "DOTALL", + "LITERAL", + "MULTILINE", + "UNICODE_CASE", + "UNIX_LINES" + ], + "x-ms-enum": { + "name": "RegexFlags", + "modelAsString": false + }, + "description": "Defines flags that can be combined to control how regular expressions are used in the pattern analyzer and pattern tokenizer.", + "externalDocs": { + "url": "http://docs.oracle.com/javase/6/docs/api/java/util/regex/Pattern.html#field_summary" + } + }, + "DataType": { + "type": "string", + "enum": [ + "Edm.String", + "Edm.Int32", + "Edm.Int64", + "Edm.Double", + "Edm.Boolean", + "Edm.DateTimeOffset", + "Edm.GeographyPoint", + "Edm.ComplexType" + ], + "x-ms-enum": { + "name": "DataType", + "modelAsString": false + }, + "description": "Defines the data type of a field in an Azure Search index." + }, + "Analyzer": { + "discriminator": "@odata.type", + "properties": { + "@odata.type": { + "type": "string" + }, + "name": { + "type": "string", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/custom-analyzers-in-azure-search#index-attribute-reference" + }, + "description": "The name of the analyzer. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters." + } + }, + "required": [ + "@odata.type", + "name" + ], + "description": "Abstract base class for analyzers." + }, + "CustomAnalyzer": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.CustomAnalyzer", + "allOf": [ + { + "$ref": "#/definitions/Analyzer" + } + ], + "properties": { + "tokenizer": { + "$ref": "#/definitions/TokenizerName", + "description": "The name of the tokenizer to use to divide continuous text into a sequence of tokens, such as breaking a sentence into words." + }, + "tokenFilters": { + "type": "array", + "items": { + "$ref": "#/definitions/TokenFilterName", + "x-nullable": false + }, + "description": "A list of token filters used to filter out or modify the tokens generated by a tokenizer. For example, you can specify a lowercase filter that converts all characters to lowercase. The filters are run in the order in which they are listed." + }, + "charFilters": { + "type": "array", + "items": { + "$ref": "#/definitions/CharFilterName", + "x-nullable": false + }, + "description": "A list of character filters used to prepare input text before it is processed by the tokenizer. For instance, they can replace certain characters or symbols. The filters are run in the order in which they are listed." + } + }, + "required": [ + "tokenizer" + ], + "description": "Allows you to take control over the process of converting text into indexable/searchable tokens. It's a user-defined configuration consisting of a single predefined tokenizer and one or more filters. The tokenizer is responsible for breaking text into tokens, and the filters for modifying tokens emitted by the tokenizer." + }, + "PatternAnalyzer": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.PatternAnalyzer", + "allOf": [ + { + "$ref": "#/definitions/Analyzer" + } + ], + "properties": { + "lowercase": { + "x-ms-client-name": "LowerCaseTerms", + "type": "boolean", + "default": true, + "description": "A value indicating whether terms should be lower-cased. Default is true." + }, + "pattern": { + "type": "string", + "default": "\\W+", + "description": "A regular expression pattern to match token separators. Default is an expression that matches one or more whitespace characters." + }, + "flags": { + "$ref": "#/definitions/RegexFlags", + "description": "Regular expression flags." + }, + "stopwords": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of stopwords." + } + }, + "description": "Flexibly separates text into terms via a regular expression pattern. This analyzer is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/PatternAnalyzer.html" + } + }, + "StandardAnalyzer": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.StandardAnalyzer", + "allOf": [ + { + "$ref": "#/definitions/Analyzer" + } + ], + "properties": { + "maxTokenLength": { + "type": "integer", + "format": "int32", + "default": 255, + "maximum": 300, + "description": "The maximum token length. Default is 255. Tokens longer than the maximum length are split. The maximum token length that can be used is 300 characters." + }, + "stopwords": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of stopwords." + } + }, + "description": "Standard Apache Lucene analyzer; Composed of the standard tokenizer, lowercase filter and stop filter.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/standard/StandardAnalyzer.html" + } + }, + "StopAnalyzer": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.StopAnalyzer", + "allOf": [ + { + "$ref": "#/definitions/Analyzer" + } + ], + "properties": { + "stopwords": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of stopwords." + } + }, + "description": "Divides text at non-letters; Applies the lowercase and stopword token filters. This analyzer is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/StopAnalyzer.html" + } + }, + "Tokenizer": { + "discriminator": "@odata.type", + "properties": { + "@odata.type": { + "type": "string" + }, + "name": { + "type": "string", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/custom-analyzers-in-azure-search#index-attribute-reference" + }, + "description": "The name of the tokenizer. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters." + } + }, + "required": [ + "@odata.type", + "name" + ], + "description": "Abstract base class for tokenizers.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search" + } + }, + "ClassicTokenizer": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.ClassicTokenizer", + "allOf": [ + { + "$ref": "#/definitions/Tokenizer" + } + ], + "properties": { + "maxTokenLength": { + "type": "integer", + "format": "int32", + "default": 255, + "maximum": 300, + "description": "The maximum token length. Default is 255. Tokens longer than the maximum length are split. The maximum token length that can be used is 300 characters." + } + }, + "description": "Grammar-based tokenizer that is suitable for processing most European-language documents. This tokenizer is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/standard/ClassicTokenizer.html" + } + }, + "TokenCharacterKind": { + "type": "string", + "enum": [ + "letter", + "digit", + "whitespace", + "punctuation", + "symbol" + ], + "x-ms-enum": { + "name": "TokenCharacterKind", + "modelAsString": false + }, + "description": "Represents classes of characters on which a token filter can operate." + }, + "EdgeNGramTokenizer": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.EdgeNGramTokenizer", + "allOf": [ + { + "$ref": "#/definitions/Tokenizer" + } + ], + "properties": { + "minGram": { + "type": "integer", + "format": "int32", + "default": 1, + "maximum": 300, + "description": "The minimum n-gram length. Default is 1. Maximum is 300. Must be less than the value of maxGram." + }, + "maxGram": { + "type": "integer", + "format": "int32", + "default": 2, + "maximum": 300, + "description": "The maximum n-gram length. Default is 2. Maximum is 300." + }, + "tokenChars": { + "type": "array", + "items": { + "$ref": "#/definitions/TokenCharacterKind", + "x-nullable": false + }, + "description": "Character classes to keep in the tokens." + } + }, + "description": "Tokenizes the input from an edge into n-grams of the given size(s). This tokenizer is implemented using Apache Lucene.", + "externalDocs": { + "url": "https://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ngram/EdgeNGramTokenizer.html" + } + }, + "KeywordTokenizer": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.KeywordTokenizer", + "allOf": [ + { + "$ref": "#/definitions/Tokenizer" + } + ], + "properties": { + "bufferSize": { + "type": "integer", + "format": "int32", + "default": 256, + "description": "The read buffer size in bytes. Default is 256." + } + }, + "description": "Emits the entire input as a single token. This tokenizer is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/KeywordTokenizer.html" + }, + "x-ms-external": true + }, + "KeywordTokenizerV2": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.KeywordTokenizerV2", + "allOf": [ + { + "$ref": "#/definitions/Tokenizer" + } + ], + "properties": { + "maxTokenLength": { + "type": "integer", + "format": "int32", + "default": 256, + "maximum": 300, + "description": "The maximum token length. Default is 256. Tokens longer than the maximum length are split. The maximum token length that can be used is 300 characters." + } + }, + "description": "Emits the entire input as a single token. This tokenizer is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/KeywordTokenizer.html" + } + }, + "MicrosoftTokenizerLanguage": { + "type": "string", + "enum": [ + "bangla", + "bulgarian", + "catalan", + "chineseSimplified", + "chineseTraditional", + "croatian", + "czech", + "danish", + "dutch", + "english", + "french", + "german", + "greek", + "gujarati", + "hindi", + "icelandic", + "indonesian", + "italian", + "japanese", + "kannada", + "korean", + "malay", + "malayalam", + "marathi", + "norwegianBokmaal", + "polish", + "portuguese", + "portugueseBrazilian", + "punjabi", + "romanian", + "russian", + "serbianCyrillic", + "serbianLatin", + "slovenian", + "spanish", + "swedish", + "tamil", + "telugu", + "thai", + "ukrainian", + "urdu", + "vietnamese" + ], + "x-ms-enum": { + "name": "MicrosoftTokenizerLanguage", + "modelAsString": false + }, + "description": "Lists the languages supported by the Microsoft language tokenizer." + }, + "MicrosoftLanguageTokenizer": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.MicrosoftLanguageTokenizer", + "allOf": [ + { + "$ref": "#/definitions/Tokenizer" + } + ], + "properties": { + "maxTokenLength": { + "type": "integer", + "format": "int32", + "default": 255, + "maximum": 300, + "description": "The maximum token length. Tokens longer than the maximum length are split. Maximum token length that can be used is 300 characters. Tokens longer than 300 characters are first split into tokens of length 300 and then each of those tokens is split based on the max token length set. Default is 255." + }, + "isSearchTokenizer": { + "type": "boolean", + "default": false, + "description": "A value indicating how the tokenizer is used. Set to true if used as the search tokenizer, set to false if used as the indexing tokenizer. Default is false." + }, + "language": { + "$ref": "#/definitions/MicrosoftTokenizerLanguage", + "description": "The language to use. The default is English." + } + }, + "description": "Divides text using language-specific rules." + }, + "MicrosoftStemmingTokenizerLanguage": { + "type": "string", + "enum": [ + "arabic", + "bangla", + "bulgarian", + "catalan", + "croatian", + "czech", + "danish", + "dutch", + "english", + "estonian", + "finnish", + "french", + "german", + "greek", + "gujarati", + "hebrew", + "hindi", + "hungarian", + "icelandic", + "indonesian", + "italian", + "kannada", + "latvian", + "lithuanian", + "malay", + "malayalam", + "marathi", + "norwegianBokmaal", + "polish", + "portuguese", + "portugueseBrazilian", + "punjabi", + "romanian", + "russian", + "serbianCyrillic", + "serbianLatin", + "slovak", + "slovenian", + "spanish", + "swedish", + "tamil", + "telugu", + "turkish", + "ukrainian", + "urdu" + ], + "x-ms-enum": { + "name": "MicrosoftStemmingTokenizerLanguage", + "modelAsString": false + }, + "description": "Lists the languages supported by the Microsoft language stemming tokenizer." + }, + "MicrosoftLanguageStemmingTokenizer": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.MicrosoftLanguageStemmingTokenizer", + "allOf": [ + { + "$ref": "#/definitions/Tokenizer" + } + ], + "properties": { + "maxTokenLength": { + "type": "integer", + "format": "int32", + "default": 255, + "maximum": 300, + "description": "The maximum token length. Tokens longer than the maximum length are split. Maximum token length that can be used is 300 characters. Tokens longer than 300 characters are first split into tokens of length 300 and then each of those tokens is split based on the max token length set. Default is 255." + }, + "isSearchTokenizer": { + "type": "boolean", + "default": false, + "description": "A value indicating how the tokenizer is used. Set to true if used as the search tokenizer, set to false if used as the indexing tokenizer. Default is false." + }, + "language": { + "$ref": "#/definitions/MicrosoftStemmingTokenizerLanguage", + "description": "The language to use. The default is English." + } + }, + "description": "Divides text using language-specific rules and reduces words to their base forms." + }, + "NGramTokenizer": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.NGramTokenizer", + "allOf": [ + { + "$ref": "#/definitions/Tokenizer" + } + ], + "properties": { + "minGram": { + "type": "integer", + "format": "int32", + "default": 1, + "maximum": 300, + "description": "The minimum n-gram length. Default is 1. Maximum is 300. Must be less than the value of maxGram." + }, + "maxGram": { + "type": "integer", + "format": "int32", + "default": 2, + "maximum": 300, + "description": "The maximum n-gram length. Default is 2. Maximum is 300." + }, + "tokenChars": { + "type": "array", + "items": { + "$ref": "#/definitions/TokenCharacterKind", + "x-nullable": false + }, + "description": "Character classes to keep in the tokens." + } + }, + "description": "Tokenizes the input into n-grams of the given size(s). This tokenizer is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ngram/NGramTokenizer.html" + } + }, + "PathHierarchyTokenizer": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.PathHierarchyTokenizer", + "allOf": [ + { + "$ref": "#/definitions/Tokenizer" + } + ], + "properties": { + "delimiter": { + "type": "string", + "format": "char", + "default": "/", + "description": "The delimiter character to use. Default is \"/\"." + }, + "replacement": { + "type": "string", + "format": "char", + "default": "/", + "description": "A value that, if set, replaces the delimiter character. Default is \"/\"." + }, + "bufferSize": { + "type": "integer", + "format": "int32", + "default": 1024, + "description": "The buffer size. Default is 1024." + }, + "reverse": { + "x-ms-client-name": "ReverseTokenOrder", + "type": "boolean", + "default": false, + "description": "A value indicating whether to generate tokens in reverse order. Default is false." + }, + "skip": { + "x-ms-client-name": "NumberOfTokensToSkip", + "type": "integer", + "format": "int32", + "default": 0, + "description": "The number of initial tokens to skip. Default is 0." + } + }, + "description": "Tokenizer for path-like hierarchies. This tokenizer is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/path/PathHierarchyTokenizer.html" + }, + "x-ms-external": true + }, + "PathHierarchyTokenizerV2": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.PathHierarchyTokenizerV2", + "allOf": [ + { + "$ref": "#/definitions/Tokenizer" + } + ], + "properties": { + "delimiter": { + "type": "string", + "format": "char", + "default": "/", + "description": "The delimiter character to use. Default is \"/\"." + }, + "replacement": { + "type": "string", + "format": "char", + "default": "/", + "description": "A value that, if set, replaces the delimiter character. Default is \"/\"." + }, + "maxTokenLength": { + "type": "integer", + "format": "int32", + "default": 300, + "maximum": 300, + "description": "The maximum token length. Default and maximum is 300." + }, + "reverse": { + "x-ms-client-name": "ReverseTokenOrder", + "type": "boolean", + "default": false, + "description": "A value indicating whether to generate tokens in reverse order. Default is false." + }, + "skip": { + "x-ms-client-name": "NumberOfTokensToSkip", + "type": "integer", + "format": "int32", + "default": 0, + "description": "The number of initial tokens to skip. Default is 0." + } + }, + "description": "Tokenizer for path-like hierarchies. This tokenizer is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/path/PathHierarchyTokenizer.html" + } + }, + "PatternTokenizer": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.PatternTokenizer", + "allOf": [ + { + "$ref": "#/definitions/Tokenizer" + } + ], + "properties": { + "pattern": { + "type": "string", + "default": "\\W+", + "description": "A regular expression pattern to match token separators. Default is an expression that matches one or more whitespace characters." + }, + "flags": { + "$ref": "#/definitions/RegexFlags", + "description": "Regular expression flags." + }, + "group": { + "type": "integer", + "format": "int32", + "default": -1, + "description": "The zero-based ordinal of the matching group in the regular expression pattern to extract into tokens. Use -1 if you want to use the entire pattern to split the input into tokens, irrespective of matching groups. Default is -1." + } + }, + "description": "Tokenizer that uses regex pattern matching to construct distinct tokens. This tokenizer is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/pattern/PatternTokenizer.html" + } + }, + "StandardTokenizer": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.StandardTokenizer", + "allOf": [ + { + "$ref": "#/definitions/Tokenizer" + } + ], + "properties": { + "maxTokenLength": { + "type": "integer", + "format": "int32", + "default": 255, + "description": "The maximum token length. Default is 255. Tokens longer than the maximum length are split." + } + }, + "description": "Breaks text following the Unicode Text Segmentation rules. This tokenizer is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/standard/StandardTokenizer.html" + }, + "x-ms-external": true + }, + "StandardTokenizerV2": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.StandardTokenizerV2", + "allOf": [ + { + "$ref": "#/definitions/Tokenizer" + } + ], + "properties": { + "maxTokenLength": { + "type": "integer", + "format": "int32", + "default": 255, + "maximum": 300, + "description": "The maximum token length. Default is 255. Tokens longer than the maximum length are split. The maximum token length that can be used is 300 characters." + } + }, + "description": "Breaks text following the Unicode Text Segmentation rules. This tokenizer is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/standard/StandardTokenizer.html" + } + }, + "UaxUrlEmailTokenizer": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.UaxUrlEmailTokenizer", + "allOf": [ + { + "$ref": "#/definitions/Tokenizer" + } + ], + "properties": { + "maxTokenLength": { + "type": "integer", + "format": "int32", + "default": 255, + "maximum": 300, + "description": "The maximum token length. Default is 255. Tokens longer than the maximum length are split. The maximum token length that can be used is 300 characters." + } + }, + "description": "Tokenizes urls and emails as one token. This tokenizer is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/standard/UAX29URLEmailTokenizer.html" + } + }, + "TokenFilter": { + "discriminator": "@odata.type", + "properties": { + "@odata.type": { + "type": "string" + }, + "name": { + "type": "string", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/custom-analyzers-in-azure-search#index-attribute-reference" + }, + "description": "The name of the token filter. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters." + } + }, + "required": [ + "@odata.type", + "name" + ], + "description": "Abstract base class for token filters.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search" + } + }, + "AsciiFoldingTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.AsciiFoldingTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "preserveOriginal": { + "type": "boolean", + "default": false, + "description": "A value indicating whether the original token will be kept. Default is false." + } + }, + "description": "Converts alphabetic, numeric, and symbolic Unicode characters which are not in the first 127 ASCII characters (the \"Basic Latin\" Unicode block) into their ASCII equivalents, if such equivalents exist. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/ASCIIFoldingFilter.html" + } + }, + "CjkBigramTokenFilterScripts": { + "type": "string", + "enum": [ + "han", + "hiragana", + "katakana", + "hangul" + ], + "x-ms-enum": { + "name": "CjkBigramTokenFilterScripts", + "modelAsString": false + }, + "description": "Scripts that can be ignored by CjkBigramTokenFilter." + }, + "CjkBigramTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.CjkBigramTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "ignoreScripts": { + "type": "array", + "items": { + "$ref": "#/definitions/CjkBigramTokenFilterScripts", + "x-nullable": false + }, + "description": "The scripts to ignore." + }, + "outputUnigrams": { + "type": "boolean", + "default": false, + "description": "A value indicating whether to output both unigrams and bigrams (if true), or just bigrams (if false). Default is false." + } + }, + "description": "Forms bigrams of CJK terms that are generated from StandardTokenizer. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/cjk/CJKBigramFilter.html" + } + }, + "CommonGramTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.CommonGramTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "commonWords": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The set of common words." + }, + "ignoreCase": { + "type": "boolean", + "default": false, + "description": "A value indicating whether common words matching will be case insensitive. Default is false." + }, + "queryMode": { + "x-ms-client-name": "UseQueryMode", + "type": "boolean", + "default": false, + "description": "A value that indicates whether the token filter is in query mode. When in query mode, the token filter generates bigrams and then removes common words and single terms followed by a common word. Default is false." + } + }, + "required": [ + "commonWords" + ], + "description": "Construct bigrams for frequently occurring terms while indexing. Single terms are still indexed too, with bigrams overlaid. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/commongrams/CommonGramsFilter.html" + } + }, + "DictionaryDecompounderTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.DictionaryDecompounderTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "wordList": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of words to match against." + }, + "minWordSize": { + "type": "integer", + "format": "int32", + "default": 5, + "maximum": 300, + "description": "The minimum word size. Only words longer than this get processed. Default is 5. Maximum is 300." + }, + "minSubwordSize": { + "type": "integer", + "format": "int32", + "default": 2, + "maximum": 300, + "description": "The minimum subword size. Only subwords longer than this are outputted. Default is 2. Maximum is 300." + }, + "maxSubwordSize": { + "type": "integer", + "format": "int32", + "default": 15, + "maximum": 300, + "description": "The maximum subword size. Only subwords shorter than this are outputted. Default is 15. Maximum is 300." + }, + "onlyLongestMatch": { + "type": "boolean", + "default": false, + "description": "A value indicating whether to add only the longest matching subword to the output. Default is false." + } + }, + "required": [ + "wordList" + ], + "description": "Decomposes compound words found in many Germanic languages. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/compound/DictionaryCompoundWordTokenFilter.html" + } + }, + "EdgeNGramTokenFilterSide": { + "type": "string", + "enum": [ + "front", + "back" + ], + "x-ms-enum": { + "name": "EdgeNGramTokenFilterSide", + "modelAsString": false + }, + "description": "Specifies which side of the input an n-gram should be generated from." + }, + "EdgeNGramTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.EdgeNGramTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "minGram": { + "type": "integer", + "format": "int32", + "default": 1, + "description": "The minimum n-gram length. Default is 1. Must be less than the value of maxGram." + }, + "maxGram": { + "type": "integer", + "format": "int32", + "default": 2, + "description": "The maximum n-gram length. Default is 2." + }, + "side": { + "$ref": "#/definitions/EdgeNGramTokenFilterSide", + "default": "front", + "description": "Specifies which side of the input the n-gram should be generated from. Default is \"front\"." + } + }, + "description": "Generates n-grams of the given size(s) starting from the front or the back of an input token. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ngram/EdgeNGramTokenFilter.html" + }, + "x-ms-external": true + }, + "EdgeNGramTokenFilterV2": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.EdgeNGramTokenFilterV2", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "minGram": { + "type": "integer", + "format": "int32", + "default": 1, + "maximum": 300, + "description": "The minimum n-gram length. Default is 1. Maximum is 300. Must be less than the value of maxGram." + }, + "maxGram": { + "type": "integer", + "format": "int32", + "default": 2, + "maximum": 300, + "description": "The maximum n-gram length. Default is 2. Maximum is 300." + }, + "side": { + "$ref": "#/definitions/EdgeNGramTokenFilterSide", + "default": "front", + "description": "Specifies which side of the input the n-gram should be generated from. Default is \"front\"." + } + }, + "description": "Generates n-grams of the given size(s) starting from the front or the back of an input token. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ngram/EdgeNGramTokenFilter.html" + } + }, + "ElisionTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.ElisionTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "articles": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The set of articles to remove." + } + }, + "description": "Removes elisions. For example, \"l'avion\" (the plane) will be converted to \"avion\" (plane). This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/util/ElisionFilter.html" + } + }, + "KeepTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.KeepTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "keepWords": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of words to keep." + }, + "keepWordsCase": { + "x-ms-client-name": "LowerCaseKeepWords", + "type": "boolean", + "default": false, + "description": "A value indicating whether to lower case all words first. Default is false." + } + }, + "required": [ + "keepWords" + ], + "description": "A token filter that only keeps tokens with text contained in a specified list of words. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/KeepWordFilter.html" + } + }, + "KeywordMarkerTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.KeywordMarkerTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "keywords": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of words to mark as keywords." + }, + "ignoreCase": { + "type": "boolean", + "default": false, + "description": "A value indicating whether to ignore case. If true, all words are converted to lower case first. Default is false." + } + }, + "required": [ + "keywords" + ], + "description": "Marks terms as keywords. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/KeywordMarkerFilter.html" + } + }, + "LengthTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.LengthTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "min": { + "type": "integer", + "format": "int32", + "default": 0, + "maximum": 300, + "description": "The minimum length in characters. Default is 0. Maximum is 300. Must be less than the value of max." + }, + "max": { + "type": "integer", + "format": "int32", + "default": 300, + "maximum": 300, + "description": "The maximum length in characters. Default and maximum is 300." + } + }, + "description": "Removes words that are too long or too short. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/LengthFilter.html" + } + }, + "LimitTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.LimitTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "maxTokenCount": { + "type": "integer", + "format": "int32", + "default": 1, + "description": "The maximum number of tokens to produce. Default is 1." + }, + "consumeAllTokens": { + "type": "boolean", + "default": false, + "description": "A value indicating whether all tokens from the input must be consumed even if maxTokenCount is reached. Default is false." + } + }, + "description": "Limits the number of tokens while indexing. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/LimitTokenCountFilter.html" + } + }, + "NGramTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.NGramTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "minGram": { + "type": "integer", + "format": "int32", + "default": 1, + "description": "The minimum n-gram length. Default is 1. Must be less than the value of maxGram." + }, + "maxGram": { + "type": "integer", + "format": "int32", + "default": 2, + "description": "The maximum n-gram length. Default is 2." + } + }, + "description": "Generates n-grams of the given size(s). This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ngram/NGramTokenFilter.html" + }, + "x-ms-external": true + }, + "NGramTokenFilterV2": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.NGramTokenFilterV2", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "minGram": { + "type": "integer", + "format": "int32", + "default": 1, + "maximum": 300, + "description": "The minimum n-gram length. Default is 1. Maximum is 300. Must be less than the value of maxGram." + }, + "maxGram": { + "type": "integer", + "format": "int32", + "default": 2, + "maximum": 300, + "description": "The maximum n-gram length. Default is 2. Maximum is 300." + } + }, + "description": "Generates n-grams of the given size(s). This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ngram/NGramTokenFilter.html" + } + }, + "PatternCaptureTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.PatternCaptureTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "patterns": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of patterns to match against each token." + }, + "preserveOriginal": { + "type": "boolean", + "default": true, + "description": "A value indicating whether to return the original token even if one of the patterns matches. Default is true." + } + }, + "required": [ + "patterns" + ], + "description": "Uses Java regexes to emit multiple tokens - one for each capture group in one or more patterns. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/pattern/PatternCaptureGroupTokenFilter.html" + } + }, + "PatternReplaceTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.PatternReplaceTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "pattern": { + "type": "string", + "description": "A regular expression pattern." + }, + "replacement": { + "type": "string", + "description": "The replacement text." + } + }, + "required": [ + "pattern", + "replacement" + ], + "description": "A character filter that replaces characters in the input string. It uses a regular expression to identify character sequences to preserve and a replacement pattern to identify characters to replace. For example, given the input text \"aa bb aa bb\", pattern \"(aa)\\s+(bb)\", and replacement \"$1#$2\", the result would be \"aa#bb aa#bb\". This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/pattern/PatternReplaceFilter.html" + } + }, + "PhoneticEncoder": { + "type": "string", + "enum": [ + "metaphone", + "doubleMetaphone", + "soundex", + "refinedSoundex", + "caverphone1", + "caverphone2", + "cologne", + "nysiis", + "koelnerPhonetik", + "haasePhonetik", + "beiderMorse" + ], + "x-ms-enum": { + "name": "PhoneticEncoder", + "modelAsString": false + }, + "description": "Identifies the type of phonetic encoder to use with a PhoneticTokenFilter." + }, + "PhoneticTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.PhoneticTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "encoder": { + "$ref": "#/definitions/PhoneticEncoder", + "default": "metaphone", + "description": "The phonetic encoder to use. Default is \"metaphone\"." + }, + "replace": { + "x-ms-client-name": "ReplaceOriginalTokens", + "type": "boolean", + "default": true, + "description": "A value indicating whether encoded tokens should replace original tokens. If false, encoded tokens are added as synonyms. Default is true." + } + }, + "description": "Create tokens for phonetic matches. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "https://lucene.apache.org/core/4_10_3/analyzers-phonetic/org/apache/lucene/analysis/phonetic/package-tree.html" + } + }, + "ShingleTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.ShingleTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "maxShingleSize": { + "type": "integer", + "format": "int32", + "default": 2, + "minimum": 2, + "description": "The maximum shingle size. Default and minimum value is 2." + }, + "minShingleSize": { + "type": "integer", + "format": "int32", + "default": 2, + "minimum": 2, + "description": "The minimum shingle size. Default and minimum value is 2. Must be less than the value of maxShingleSize." + }, + "outputUnigrams": { + "type": "boolean", + "default": true, + "description": "A value indicating whether the output stream will contain the input tokens (unigrams) as well as shingles. Default is true." + }, + "outputUnigramsIfNoShingles": { + "type": "boolean", + "default": false, + "description": "A value indicating whether to output unigrams for those times when no shingles are available. This property takes precedence when outputUnigrams is set to false. Default is false." + }, + "tokenSeparator": { + "type": "string", + "default": " ", + "description": "The string to use when joining adjacent tokens to form a shingle. Default is a single space (\" \")." + }, + "filterToken": { + "type": "string", + "default": "_", + "description": "The string to insert for each position at which there is no token. Default is an underscore (\"_\")." + } + }, + "description": "Creates combinations of tokens as a single token. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/shingle/ShingleFilter.html" + } + }, + "SnowballTokenFilterLanguage": { + "type": "string", + "enum": [ + "armenian", + "basque", + "catalan", + "danish", + "dutch", + "english", + "finnish", + "french", + "german", + "german2", + "hungarian", + "italian", + "kp", + "lovins", + "norwegian", + "porter", + "portuguese", + "romanian", + "russian", + "spanish", + "swedish", + "turkish" + ], + "x-ms-enum": { + "name": "SnowballTokenFilterLanguage", + "modelAsString": false + }, + "description": "The language to use for a Snowball token filter." + }, + "SnowballTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.SnowballTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "language": { + "$ref": "#/definitions/SnowballTokenFilterLanguage", + "description": "The language to use." + } + }, + "required": [ + "language" + ], + "description": "A filter that stems words using a Snowball-generated stemmer. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/snowball/SnowballFilter.html" + } + }, + "StemmerTokenFilterLanguage": { + "type": "string", + "enum": [ + "arabic", + "armenian", + "basque", + "brazilian", + "bulgarian", + "catalan", + "czech", + "danish", + "dutch", + "dutchKp", + "english", + "lightEnglish", + "minimalEnglish", + "possessiveEnglish", + "porter2", + "lovins", + "finnish", + "lightFinnish", + "french", + "lightFrench", + "minimalFrench", + "galician", + "minimalGalician", + "german", + "german2", + "lightGerman", + "minimalGerman", + "greek", + "hindi", + "hungarian", + "lightHungarian", + "indonesian", + "irish", + "italian", + "lightItalian", + "sorani", + "latvian", + "norwegian", + "lightNorwegian", + "minimalNorwegian", + "lightNynorsk", + "minimalNynorsk", + "portuguese", + "lightPortuguese", + "minimalPortuguese", + "portugueseRslp", + "romanian", + "russian", + "lightRussian", + "spanish", + "lightSpanish", + "swedish", + "lightSwedish", + "turkish" + ], + "x-ms-enum": { + "name": "StemmerTokenFilterLanguage", + "modelAsString": false + }, + "description": "The language to use for a stemmer token filter." + }, + "StemmerTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.StemmerTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "language": { + "$ref": "#/definitions/StemmerTokenFilterLanguage", + "description": "The language to use." + } + }, + "required": [ + "language" + ], + "description": "Language specific stemming filter. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search#TokenFilters" + } + }, + "StemmerOverrideTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.StemmerOverrideTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "rules": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of stemming rules in the following format: \"word => stem\", for example: \"ran => run\"." + } + }, + "required": [ + "rules" + ], + "description": "Provides the ability to override other stemming filters with custom dictionary-based stemming. Any dictionary-stemmed terms will be marked as keywords so that they will not be stemmed with stemmers down the chain. Must be placed before any stemming filters. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/StemmerOverrideFilter.html" + } + }, + "StopwordsList": { + "type": "string", + "enum": [ + "arabic", + "armenian", + "basque", + "brazilian", + "bulgarian", + "catalan", + "czech", + "danish", + "dutch", + "english", + "finnish", + "french", + "galician", + "german", + "greek", + "hindi", + "hungarian", + "indonesian", + "irish", + "italian", + "latvian", + "norwegian", + "persian", + "portuguese", + "romanian", + "russian", + "sorani", + "spanish", + "swedish", + "thai", + "turkish" + ], + "x-ms-enum": { + "name": "StopwordsList", + "modelAsString": false + }, + "description": "Identifies a predefined list of language-specific stopwords." + }, + "StopwordsTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.StopwordsTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "stopwords": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of stopwords. This property and the stopwords list property cannot both be set." + }, + "stopwordsList": { + "$ref": "#/definitions/StopwordsList", + "default": "english", + "description": "A predefined list of stopwords to use. This property and the stopwords property cannot both be set. Default is English." + }, + "ignoreCase": { + "type": "boolean", + "default": false, + "description": "A value indicating whether to ignore case. If true, all words are converted to lower case first. Default is false." + }, + "removeTrailing": { + "x-ms-client-name": "RemoveTrailingStopWords", + "type": "boolean", + "default": true, + "description": "A value indicating whether to ignore the last search term if it's a stop word. Default is true." + } + }, + "description": "Removes stop words from a token stream. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/StopFilter.html" + } + }, + "SynonymTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.SynonymTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "synonyms": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of synonyms in following one of two formats: 1. incredible, unbelievable, fabulous => amazing - all terms on the left side of => symbol will be replaced with all terms on its right side; 2. incredible, unbelievable, fabulous, amazing - comma separated list of equivalent words. Set the expand option to change how this list is interpreted." + }, + "ignoreCase": { + "type": "boolean", + "default": false, + "description": "A value indicating whether to case-fold input for matching. Default is false." + }, + "expand": { + "type": "boolean", + "default": true, + "description": "A value indicating whether all words in the list of synonyms (if => notation is not used) will map to one another. If true, all words in the list of synonyms (if => notation is not used) will map to one another. The following list: incredible, unbelievable, fabulous, amazing is equivalent to: incredible, unbelievable, fabulous, amazing => incredible, unbelievable, fabulous, amazing. If false, the following list: incredible, unbelievable, fabulous, amazing will be equivalent to: incredible, unbelievable, fabulous, amazing => incredible. Default is true." + } + }, + "required": [ + "synonyms" + ], + "description": "Matches single or multi-word synonyms in a token stream. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/synonym/SynonymFilter.html" + } + }, + "TruncateTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.TruncateTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "length": { + "type": "integer", + "format": "int32", + "default": 300, + "maximum": 300, + "description": "The length at which terms will be truncated. Default and maximum is 300." + } + }, + "description": "Truncates the terms to a specific length. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/TruncateTokenFilter.html" + } + }, + "UniqueTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.UniqueTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "onlyOnSamePosition": { + "type": "boolean", + "default": false, + "description": "A value indicating whether to remove duplicates only at the same position. Default is false." + } + }, + "description": "Filters out tokens with same text as the previous token. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/RemoveDuplicatesTokenFilter.html" + } + }, + "WordDelimiterTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.WordDelimiterTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "generateWordParts": { + "type": "boolean", + "default": true, + "description": "A value indicating whether to generate part words. If set, causes parts of words to be generated; for example \"AzureSearch\" becomes \"Azure\" \"Search\". Default is true." + }, + "generateNumberParts": { + "type": "boolean", + "default": true, + "description": "A value indicating whether to generate number subwords. Default is true." + }, + "catenateWords": { + "type": "boolean", + "default": false, + "description": "A value indicating whether maximum runs of word parts will be catenated. For example, if this is set to true, \"Azure-Search\" becomes \"AzureSearch\". Default is false." + }, + "catenateNumbers": { + "type": "boolean", + "default": false, + "description": "A value indicating whether maximum runs of number parts will be catenated. For example, if this is set to true, \"1-2\" becomes \"12\". Default is false." + }, + "catenateAll": { + "type": "boolean", + "default": false, + "description": "A value indicating whether all subword parts will be catenated. For example, if this is set to true, \"Azure-Search-1\" becomes \"AzureSearch1\". Default is false." + }, + "splitOnCaseChange": { + "type": "boolean", + "default": true, + "description": "A value indicating whether to split words on caseChange. For example, if this is set to true, \"AzureSearch\" becomes \"Azure\" \"Search\". Default is true." + }, + "preserveOriginal": { + "type": "boolean", + "default": false, + "description": "A value indicating whether original words will be preserved and added to the subword list. Default is false." + }, + "splitOnNumerics": { + "type": "boolean", + "default": true, + "description": "A value indicating whether to split on numbers. For example, if this is set to true, \"Azure1Search\" becomes \"Azure\" \"1\" \"Search\". Default is true." + }, + "stemEnglishPossessive": { + "type": "boolean", + "default": true, + "description": "A value indicating whether to remove trailing \"'s\" for each subword. Default is true." + }, + "protectedWords": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of tokens to protect from being delimited." + } + }, + "description": "Splits words into subwords and performs optional transformations on subword groups. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/WordDelimiterFilter.html" + } + }, + "CharFilter": { + "discriminator": "@odata.type", + "properties": { + "@odata.type": { + "type": "string" + }, + "name": { + "type": "string", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/custom-analyzers-in-azure-search#index-attribute-reference" + }, + "description": "The name of the char filter. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters." + } + }, + "required": [ + "@odata.type", + "name" + ], + "description": "Abstract base class for character filters.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search" + } + }, + "MappingCharFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.MappingCharFilter", + "allOf": [ + { + "$ref": "#/definitions/CharFilter" + } + ], + "properties": { + "mappings": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of mappings of the following format: \"a=>b\" (all occurrences of the character \"a\" will be replaced with character \"b\")." + } + }, + "required": [ + "mappings" + ], + "description": "A character filter that applies mappings defined with the mappings option. Matching is greedy (longest pattern matching at a given point wins). Replacement is allowed to be the empty string. This character filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "https://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/charfilter/MappingCharFilter.html" + } + }, + "PatternReplaceCharFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.PatternReplaceCharFilter", + "allOf": [ + { + "$ref": "#/definitions/CharFilter" + } + ], + "properties": { + "pattern": { + "type": "string", + "description": "A regular expression pattern." + }, + "replacement": { + "type": "string", + "description": "The replacement text." + } + }, + "required": [ + "pattern", + "replacement" + ], + "description": "A character filter that replaces characters in the input string. It uses a regular expression to identify character sequences to preserve and a replacement pattern to identify characters to replace. For example, given the input text \"aa bb aa bb\", pattern \"(aa)\\s+(bb)\", and replacement \"$1#$2\", the result would be \"aa#bb aa#bb\". This character filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "https://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/pattern/PatternReplaceCharFilter.html" + } + }, + "DataSourceCredentials": { + "properties": { + "connectionString": { + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Create-Data-Source" + }, + "type": "string", + "description": "The connection string for the datasource." + } + }, + "description": "Represents credentials that can be used to connect to a datasource." + }, + "DataContainer": { + "properties": { + "name": { + "type": "string", + "description": "The name of the table or view (for Azure SQL data source) or collection (for DocumentDB data source) that will be indexed." + }, + "query": { + "type": "string", + "description": "A query that is applied to this data container. The syntax and meaning of this parameter is datasource-specific. Not supported by Azure SQL datasources." + } + }, + "required": [ + "name" + ], + "description": "Represents information about the entity (such as Azure SQL table or DocumentDb collection) that will be indexed." + }, + "DataChangeDetectionPolicy": { + "discriminator": "@odata.type", + "properties": { + "@odata.type": { + "type": "string" + } + }, + "required": [ + "@odata.type" + ], + "description": "Abstract base class for data change detection policies." + }, + "HighWaterMarkChangeDetectionPolicy": { + "description": "Defines a data change detection policy that captures changes based on the value of a high water mark column.", + "x-ms-discriminator-value": "#Microsoft.Azure.Search.HighWaterMarkChangeDetectionPolicy", + "allOf": [ + { + "$ref": "#/definitions/DataChangeDetectionPolicy" + } + ], + "properties": { + "highWaterMarkColumnName": { + "type": "string", + "description": "The name of the high water mark column." + } + }, + "required": [ + "highWaterMarkColumnName" + ] + }, + "SqlIntegratedChangeTrackingPolicy": { + "description": "Defines a data change detection policy that captures changes using the Integrated Change Tracking feature of Azure SQL Database.", + "x-ms-discriminator-value": "#Microsoft.Azure.Search.SqlIntegratedChangeTrackingPolicy", + "allOf": [ + { + "$ref": "#/definitions/DataChangeDetectionPolicy" + } + ] + }, + "DataDeletionDetectionPolicy": { + "discriminator": "@odata.type", + "properties": { + "@odata.type": { + "type": "string" + } + }, + "required": [ + "@odata.type" + ], + "description": "Abstract base class for data deletion detection policies." + }, + "SoftDeleteColumnDeletionDetectionPolicy": { + "description": "Defines a data deletion detection policy that implements a soft-deletion strategy. It determines whether an item should be deleted based on the value of a designated 'soft delete' column.", + "x-ms-discriminator-value": "#Microsoft.Azure.Search.SoftDeleteColumnDeletionDetectionPolicy", + "allOf": [ + { + "$ref": "#/definitions/DataDeletionDetectionPolicy" + } + ], + "properties": { + "softDeleteColumnName": { + "type": "string", + "description": "The name of the column to use for soft-deletion detection." + }, + "softDeleteMarkerValue": { + "type": "string", + "description": "The marker value that identifies an item as deleted." + } + } + }, + "DataSourceType": { + "type": "string", + "enum": [ + "azuresql", + "cosmosdb", + "azureblob", + "azuretable" + ], + "x-ms-enum": { + "name": "DataSourceType", + "modelAsString": false + }, + "description": "Defines the type of an Azure Search datasource." + }, + "DataSource": { + "properties": { + "name": { + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Naming-rules" + }, + "type": "string", + "description": "The name of the datasource." + }, + "description": { + "type": "string", + "description": "The description of the datasource." + }, + "type": { + "$ref": "#/definitions/DataSourceType", + "description": "The type of the datasource." + }, + "credentials": { + "$ref": "#/definitions/DataSourceCredentials", + "description": "Credentials for the datasource." + }, + "container": { + "$ref": "#/definitions/DataContainer", + "description": "The data container for the datasource." + }, + "dataChangeDetectionPolicy": { + "$ref": "#/definitions/DataChangeDetectionPolicy", + "description": "The data change detection policy for the datasource." + }, + "dataDeletionDetectionPolicy": { + "$ref": "#/definitions/DataDeletionDetectionPolicy", + "description": "The data deletion detection policy for the datasource." + }, + "@odata.etag": { + "x-ms-client-name": "ETag", + "type": "string", + "description": "The ETag of the DataSource." + } + }, + "required": [ + "name", + "type", + "credentials", + "container" + ], + "description": "Represents a datasource definition in Azure Search, which can be used to configure an indexer." + }, + "DataSourceListResult": { + "properties": { + "value": { + "x-ms-client-name": "DataSources", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/DataSource" + }, + "description": "The datasources in the Search service." + } + }, + "description": "Response from a List Datasources request. If successful, it includes the full definitions of all datasources." + }, + "IndexingSchedule": { + "properties": { + "interval": { + "type": "string", + "format": "duration", + "description": "The interval of time between indexer executions." + }, + "startTime": { + "type": "string", + "format": "date-time", + "description": "The time when an indexer should start running." + } + }, + "required": [ + "interval" + ], + "description": "Represents a schedule for indexer execution." + }, + "IndexingParameters": { + "properties": { + "batchSize": { + "type": "integer", + "format": "int32", + "description": "The number of items that are read from the data source and indexed as a single batch in order to improve performance. The default depends on the data source type." + }, + "maxFailedItems": { + "type": "integer", + "format": "int32", + "default": 0, + "description": "The maximum number of items that can fail indexing for indexer execution to still be considered successful. -1 means no limit. Default is 0." + }, + "maxFailedItemsPerBatch": { + "type": "integer", + "format": "int32", + "default": 0, + "description": "The maximum number of items in a single batch that can fail indexing for the batch to still be considered successful. -1 means no limit. Default is 0." + }, + "base64EncodeKeys": { + "type": "boolean", + "default": false, + "description": "Whether indexer will base64-encode all values that are inserted into key field of the target index. This is needed if keys can contain characters that are invalid in keys (such as dot '.'). Default is false." + }, + "configuration": { + "type": "object", + "additionalProperties": { + "type": "object" + }, + "description": "A dictionary of indexer-specific configuration properties. Each name is the name of a specific property. Each value must be of a primitive type." + } + }, + "description": "Represents parameters for indexer execution.", + "x-ms-external": true + }, + "FieldMappingFunction": { + "properties": { + "name": { + "type": "string", + "description": "The name of the field mapping function." + }, + "parameters": { + "type": "object", + "additionalProperties": { + "type": "object" + }, + "description": "A dictionary of parameter name/value pairs to pass to the function. Each value must be of a primitive type." + } + }, + "required": [ + "name" + ], + "description": "Represents a function that transforms a value from a data source before indexing.", + "externalDocs": { + "url": "https://docs.microsoft.com/azure/search/search-indexer-field-mappings" + } + }, + "FieldMapping": { + "properties": { + "sourceFieldName": { + "type": "string", + "description": "The name of the field in the data source." + }, + "targetFieldName": { + "type": "string", + "description": "The name of the target field in the index. Same as the source field name by default." + }, + "mappingFunction": { + "$ref": "#/definitions/FieldMappingFunction", + "description": "A function to apply to each source field value before indexing." + } + }, + "required": [ + "sourceFieldName" + ], + "description": "Defines a mapping between a field in a data source and a target field in an index.", + "externalDocs": { + "url": "https://docs.microsoft.com/azure/search/search-indexer-field-mappings" + } + }, + "Indexer": { + "properties": { + "name": { + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Naming-rules" + }, + "type": "string", + "description": "The name of the indexer." + }, + "description": { + "type": "string", + "description": "The description of the indexer." + }, + "dataSourceName": { + "type": "string", + "description": "The name of the datasource from which this indexer reads data." + }, + "skillsetName": { + "type": "string", + "description": "The name of the cognitive skillset executing with this indexer." + }, + "targetIndexName": { + "type": "string", + "description": "The name of the index to which this indexer writes data." + }, + "schedule": { + "$ref": "#/definitions/IndexingSchedule", + "description": "The schedule for this indexer." + }, + "parameters": { + "$ref": "#/definitions/IndexingParameters", + "description": "Parameters for indexer execution." + }, + "fieldMappings": { + "type": "array", + "items": { + "$ref": "#/definitions/FieldMapping" + }, + "description": "Defines mappings between fields in the data source and corresponding target fields in the index.", + "externalDocs": { + "url": "https://docs.microsoft.com/azure/search/search-indexer-field-mappings" + } + }, + "outputFieldMappings": { + "type": "array", + "items": { + "$ref": "#/definitions/FieldMapping" + }, + "description": "Output field mappings are applied after enrichment and immediately before indexing.", + "externalDocs": { + "url": "https://docs.microsoft.com/azure/search/search-indexer-field-mappings" + } + }, + "disabled": { + "x-ms-client-name": "IsDisabled", + "type": "boolean", + "default": false, + "description": "A value indicating whether the indexer is disabled. Default is false." + }, + "@odata.etag": { + "x-ms-client-name": "ETag", + "type": "string", + "description": "The ETag of the Indexer." + } + }, + "required": [ + "name", + "dataSourceName", + "targetIndexName" + ], + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Indexer-operations" + }, + "description": "Represents an Azure Search indexer." + }, + "IndexerListResult": { + "properties": { + "value": { + "x-ms-client-name": "Indexers", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/Indexer" + }, + "description": "The indexers in the Search service." + } + }, + "description": "Response from a List Indexers request. If successful, it includes the full definitions of all indexers." + }, + "ItemError": { + "properties": { + "key": { + "type": "string", + "readOnly": true, + "description": "The key of the item for which indexing failed." + }, + "errorMessage": { + "type": "string", + "readOnly": true, + "description": "The message describing the error that occurred while processing the item." + }, + "statusCode": { + "type": "integer", + "format": "int32", + "x-nullable": false, + "readOnly": true, + "description": "The status code indicating why the indexing operation failed. Possible values include: 400 for a malformed input document, 404 for document not found, 409 for a version conflict, 422 when the index is temporarily unavailable, or 503 for when the service is too busy." + } + }, + "description": "Represents an item- or document-level indexing error." + }, + "ItemWarning": { + "properties": { + "key": { + "type": "string", + "readOnly": true, + "description": "The key of the item which generated a warning." + }, + "message": { + "type": "string", + "readOnly": true, + "description": "The message describing the warning that occurred while processing the item." + } + }, + "description": "Represents an item-level warning." + }, + "IndexerExecutionResult": { + "properties": { + "status": { + "$ref": "#/definitions/IndexerExecutionStatus", + "readOnly": true, + "description": "The outcome of this indexer execution." + }, + "errorMessage": { + "type": "string", + "readOnly": true, + "description": "The error message indicating the top-level error, if any." + }, + "startTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "The start time of this indexer execution." + }, + "endTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "The end time of this indexer execution, if the execution has already completed." + }, + "errors": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/ItemError" + }, + "description": "The item-level indexing errors." + }, + "warnings": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/ItemWarning" + }, + "description": "The item-level indexing warnings." + }, + "itemsProcessed": { + "x-ms-client-name": "ItemCount", + "type": "integer", + "format": "int32", + "x-nullable": false, + "readOnly": true, + "description": "The number of items that were processed during this indexer execution. This includes both successfully processed items and items where indexing was attempted but failed." + }, + "itemsFailed": { + "x-ms-client-name": "FailedItemCount", + "type": "integer", + "format": "int32", + "x-nullable": false, + "readOnly": true, + "description": "The number of items that failed to be indexed during this indexer execution." + }, + "initialTrackingState": { + "type": "string", + "readOnly": true, + "description": "Change tracking state with which an indexer execution started." + }, + "finalTrackingState": { + "type": "string", + "readOnly": true, + "description": "Change tracking state with which an indexer execution finished." + } + }, + "description": "Represents the result of an individual indexer execution." + }, + "IndexerExecutionStatus": { + "type": "string", + "enum": [ + "transientFailure", + "success", + "inProgress", + "reset" + ], + "x-ms-enum": { + "name": "IndexerExecutionStatus" + }, + "x-nullable": false, + "description": "Represents the status of an individual indexer execution." + }, + "IndexerExecutionInfo": { + "properties": { + "status": { + "$ref": "#/definitions/IndexerStatus", + "readOnly": true, + "description": "Overall indexer status." + }, + "lastResult": { + "$ref": "#/definitions/IndexerExecutionResult", + "readOnly": true, + "description": "The result of the most recent or an in-progress indexer execution." + }, + "executionHistory": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/IndexerExecutionResult" + }, + "description": "History of the recent indexer executions, sorted in reverse chronological order." + } + }, + "description": "Represents the current status and execution history of an indexer." + }, + "IndexerStatus": { + "type": "string", + "enum": [ + "unknown", + "error", + "running" + ], + "x-ms-enum": { + "name": "IndexerStatus" + }, + "x-nullable": false, + "description": "Represents the overall indexer status." + }, + "Field": { + "properties": { + "name": { + "type": "string", + "description": "The name of the field, which must be unique within the fields collection of the index or parent field.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Naming-rules" + } + }, + "type": { + "$ref": "#/definitions/DataType", + "description": "The data type of the field.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/supported-data-types" + } + }, + "key": { + "type": "boolean", + "description": "A value indicating whether the field uniquely identifies documents in the index. Exactly one top-level field in each index must be chosen as the key field and it must be of type Edm.String. Key fields can be used to look up documents directly and update or delete specific documents. Default is false for simple fields and null for complex fields." + }, + "retrievable": { + "type": "boolean", + "description": "A value indicating whether the field can be returned in a search result. You can disable this option if you want to use a field (for example, margin) as a filter, sorting, or scoring mechanism but do not want the field to be visible to the end user. This property must be true for key fields, and it must be null for complex fields. This property can be changed on existing fields. Enabling this property does not cause any increase in index storage requirements. Default is true for simple fields and null for complex fields." + }, + "searchable": { + "type": "boolean", + "description": "A value indicating whether the field is full-text searchable. This means it will undergo analysis such as word-breaking during indexing. If you set a searchable field to a value like \"sunny day\", internally it will be split into the individual tokens \"sunny\" and \"day\". This enables full-text searches for these terms. Fields of type Edm.String or Collection(Edm.String) are searchable by default. This property must be false for simple fields of other non-string data types, and it must be null for complex fields. Note: searchable fields consume extra space in your index since Azure Search will store an additional tokenized version of the field value for full-text searches. If you want to save space in your index and you don't need a field to be included in searches, set searchable to false." + }, + "filterable": { + "type": "boolean", + "description": "A value indicating whether to enable the field to be referenced in $filter queries. filterable differs from searchable in how strings are handled. Fields of type Edm.String or Collection(Edm.String) that are filterable do not undergo word-breaking, so comparisons are for exact matches only. For example, if you set such a field f to \"sunny day\", $filter=f eq 'sunny' will find no matches, but $filter=f eq 'sunny day' will. This property must be null for complex fields. Default is true for simple fields and null for complex fields." + }, + "sortable": { + "type": "boolean", + "description": "A value indicating whether to enable the field to be referenced in $orderby expressions. By default Azure Search sorts results by score, but in many experiences users will want to sort by fields in the documents. A simple field can be sortable only if it is single-valued (it has a single value in the scope of the parent document). Simple collection fields cannot be sortable, since they are multi-valued. Simple sub-fields of complex collections are also multi-valued, and therefore cannot be sortable. This is true whether it's an immediate parent field, or an ancestor field, that's the complex collection. Complex fields cannot be sortable and the sortable property must be null for such fields. The default for sortable is true for single-valued simple fields, false for multi-valued simple fields, and null for complex fields." + }, + "facetable": { + "type": "boolean", + "description": "A value indicating whether to enable the field to be referenced in facet queries. Typically used in a presentation of search results that includes hit count by category (for example, search for digital cameras and see hits by brand, by megapixels, by price, and so on). This property must be null for complex fields. Fields of type Edm.GeographyPoint or Collection(Edm.GeographyPoint) cannot be facetable. Default is true for all other simple fields." + }, + "analyzer": { + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Language-support" + }, + "$ref": "#/definitions/AnalyzerName", + "description": "The name of the language analyzer to use for the field. This option can be used only with searchable fields and it can't be set together with either searchAnalyzer or indexAnalyzer. Once the analyzer is chosen, it cannot be changed for the field. Must be null for complex fields." + }, + "searchAnalyzer": { + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Language-support" + }, + "$ref": "#/definitions/AnalyzerName", + "description": "The name of the analyzer used at search time for the field. This option can be used only with searchable fields. It must be set together with indexAnalyzer and it cannot be set together with the analyzer option. This analyzer can be updated on an existing field. Must be null for complex fields." + }, + "indexAnalyzer": { + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Language-support" + }, + "$ref": "#/definitions/AnalyzerName", + "description": "The name of the analyzer used at indexing time for the field. This option can be used only with searchable fields. It must be set together with searchAnalyzer and it cannot be set together with the analyzer option. Once the analyzer is chosen, it cannot be changed for the field. Must be null for complex fields." + }, + "synonymMaps": { + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Synonym-Map-operations" + }, + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of the names of synonym maps to associate with this field. This option can be used only with searchable fields. Currently only one synonym map per field is supported. Assigning a synonym map to a field ensures that query terms targeting that field are expanded at query-time using the rules in the synonym map. This attribute can be changed on existing fields. Must be null or an empty collection for complex fields." + }, + "fields": { + "type": "array", + "items": { + "$ref": "#/definitions/Field" + }, + "description": "A list of sub-fields if this is a field of type Edm.ComplexType or Collection(Edm.ComplexType). Must be null or empty for simple fields." + } + }, + "required": [ + "name", + "type" + ], + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Create-Index" + }, + "description": "Represents a field in an index definition in Azure Search, which describes the name, data type, and search behavior of a field." + }, + "TextWeights": { + "properties": { + "weights": { + "type": "object", + "additionalProperties": { + "type": "number", + "format": "double", + "x-nullable": false + }, + "description": "The dictionary of per-field weights to boost document scoring. The keys are field names and the values are the weights for each field." + } + }, + "required": [ + "weights" + ], + "description": "Defines weights on index fields for which matches should boost scoring in search queries." + }, + "ScoringFunction": { + "discriminator": "type", + "properties": { + "type": { + "type": "string" + }, + "fieldName": { + "type": "string", + "description": "The name of the field used as input to the scoring function." + }, + "boost": { + "type": "number", + "format": "double", + "description": "A multiplier for the raw score. Must be a positive number not equal to 1.0." + }, + "interpolation": { + "$ref": "#/definitions/ScoringFunctionInterpolation", + "description": "A value indicating how boosting will be interpolated across document scores; defaults to \"Linear\"." + } + }, + "required": [ + "type", + "fieldName", + "boost" + ], + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Add-scoring-profiles-to-a-search-index" + }, + "description": "Abstract base class for functions that can modify document scores during ranking." + }, + "DistanceScoringFunction": { + "x-ms-discriminator-value": "distance", + "allOf": [ + { + "$ref": "#/definitions/ScoringFunction" + } + ], + "properties": { + "distance": { + "x-ms-client-name": "Parameters", + "$ref": "#/definitions/DistanceScoringParameters", + "description": "Parameter values for the distance scoring function." + } + }, + "required": [ + "distance" + ], + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Add-scoring-profiles-to-a-search-index" + }, + "description": "Defines a function that boosts scores based on distance from a geographic location." + }, + "DistanceScoringParameters": { + "properties": { + "referencePointParameter": { + "type": "string", + "description": "The name of the parameter passed in search queries to specify the reference location." + }, + "boostingDistance": { + "type": "number", + "format": "double", + "description": "The distance in kilometers from the reference location where the boosting range ends." + } + }, + "required": [ + "referencePointParameter", + "boostingDistance" + ], + "description": "Provides parameter values to a distance scoring function." + }, + "FreshnessScoringFunction": { + "x-ms-discriminator-value": "freshness", + "allOf": [ + { + "$ref": "#/definitions/ScoringFunction" + } + ], + "properties": { + "freshness": { + "x-ms-client-name": "Parameters", + "$ref": "#/definitions/FreshnessScoringParameters", + "description": "Parameter values for the freshness scoring function." + } + }, + "required": [ + "freshness" + ], + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Add-scoring-profiles-to-a-search-index" + }, + "description": "Defines a function that boosts scores based on the value of a date-time field." + }, + "FreshnessScoringParameters": { + "properties": { + "boostingDuration": { + "type": "string", + "format": "duration", + "description": "The expiration period after which boosting will stop for a particular document." + } + }, + "required": [ + "boostingDuration" + ], + "description": "Provides parameter values to a freshness scoring function." + }, + "MagnitudeScoringFunction": { + "x-ms-discriminator-value": "magnitude", + "allOf": [ + { + "$ref": "#/definitions/ScoringFunction" + } + ], + "properties": { + "magnitude": { + "x-ms-client-name": "Parameters", + "$ref": "#/definitions/MagnitudeScoringParameters", + "description": "Parameter values for the magnitude scoring function." + } + }, + "required": [ + "magnitude" + ], + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Add-scoring-profiles-to-a-search-index" + }, + "description": "Defines a function that boosts scores based on the magnitude of a numeric field." + }, + "MagnitudeScoringParameters": { + "properties": { + "boostingRangeStart": { + "type": "number", + "format": "double", + "description": "The field value at which boosting starts." + }, + "boostingRangeEnd": { + "type": "number", + "format": "double", + "description": "The field value at which boosting ends." + }, + "constantBoostBeyondRange": { + "x-ms-client-name": "ShouldBoostBeyondRangeByConstant", + "type": "boolean", + "description": "A value indicating whether to apply a constant boost for field values beyond the range end value; default is false." + } + }, + "required": [ + "boostingRangeStart", + "boostingRangeEnd" + ], + "description": "Provides parameter values to a magnitude scoring function." + }, + "TagScoringFunction": { + "x-ms-discriminator-value": "tag", + "allOf": [ + { + "$ref": "#/definitions/ScoringFunction" + } + ], + "properties": { + "tag": { + "x-ms-client-name": "Parameters", + "$ref": "#/definitions/TagScoringParameters", + "description": "Parameter values for the tag scoring function." + } + }, + "required": [ + "tag" + ], + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Add-scoring-profiles-to-a-search-index" + }, + "description": "Defines a function that boosts scores of documents with string values matching a given list of tags." + }, + "TagScoringParameters": { + "properties": { + "tagsParameter": { + "type": "string", + "description": "The name of the parameter passed in search queries to specify the list of tags to compare against the target field." + } + }, + "required": [ + "tagsParameter" + ], + "description": "Provides parameter values to a tag scoring function." + }, + "ScoringFunctionInterpolation": { + "type": "string", + "enum": [ + "linear", + "constant", + "quadratic", + "logarithmic" + ], + "x-ms-enum": { + "name": "ScoringFunctionInterpolation" + }, + "description": "Defines the function used to interpolate score boosting across a range of documents." + }, + "ScoringProfile": { + "properties": { + "name": { + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Naming-rules" + }, + "type": "string", + "description": "The name of the scoring profile." + }, + "text": { + "x-ms-client-name": "TextWeights", + "$ref": "#/definitions/TextWeights", + "description": "Parameters that boost scoring based on text matches in certain index fields." + }, + "functions": { + "type": "array", + "items": { + "$ref": "#/definitions/ScoringFunction" + }, + "description": "The collection of functions that influence the scoring of documents." + }, + "functionAggregation": { + "$ref": "#/definitions/ScoringFunctionAggregation", + "description": "A value indicating how the results of individual scoring functions should be combined. Defaults to \"Sum\". Ignored if there are no scoring functions." + } + }, + "required": [ + "name" + ], + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Add-scoring-profiles-to-a-search-index" + }, + "description": "Defines parameters for an Azure Search index that influence scoring in search queries." + }, + "ScoringFunctionAggregation": { + "type": "string", + "enum": [ + "sum", + "average", + "minimum", + "maximum", + "firstMatching" + ], + "x-ms-enum": { + "name": "ScoringFunctionAggregation" + }, + "description": "Defines the aggregation function used to combine the results of all the scoring functions in a scoring profile." + }, + "CorsOptions": { + "properties": { + "allowedOrigins": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of origins from which JavaScript code will be granted access to your index. Can contain a list of hosts of the form {protocol}://{fully-qualified-domain-name}[:{port#}], or a single '*' to allow all origins (not recommended)." + }, + "maxAgeInSeconds": { + "type": "integer", + "format": "int64", + "description": "The duration for which browsers should cache CORS preflight responses. Defaults to 5 minutes." + } + }, + "required": [ + "allowedOrigins" + ], + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Create-Index" + }, + "description": "Defines options to control Cross-Origin Resource Sharing (CORS) for an index." + }, + "Suggester": { + "properties": { + "name": { + "type": "string", + "description": "The name of the suggester." + }, + "searchMode": { + "type": "string", + "enum": [ + "analyzingInfixMatching" + ], + "x-ms-enum": { + "name": "searchMode", + "modelAsString": false + }, + "description": "A value indicating the capabilities of the suggester." + }, + "sourceFields": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of field names to which the suggester applies. Each field must be searchable." + } + }, + "required": [ + "name", + "searchMode", + "sourceFields" + ], + "description": "Defines how the Suggest API should apply to a group of fields in the index." + }, + "Index": { + "properties": { + "name": { + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Naming-rules" + }, + "type": "string", + "description": "The name of the index." + }, + "fields": { + "type": "array", + "items": { + "$ref": "#/definitions/Field" + }, + "description": "The fields of the index." + }, + "scoringProfiles": { + "type": "array", + "items": { + "$ref": "#/definitions/ScoringProfile" + }, + "description": "The scoring profiles for the index." + }, + "defaultScoringProfile": { + "type": "string", + "description": "The name of the scoring profile to use if none is specified in the query. If this property is not set and no scoring profile is specified in the query, then default scoring (tf-idf) will be used." + }, + "corsOptions": { + "$ref": "#/definitions/CorsOptions", + "description": "Options to control Cross-Origin Resource Sharing (CORS) for the index." + }, + "suggesters": { + "type": "array", + "items": { + "$ref": "#/definitions/Suggester" + }, + "description": "The suggesters for the index." + }, + "analyzers": { + "type": "array", + "items": { + "$ref": "#/definitions/Analyzer" + }, + "description": "The analyzers for the index.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search" + } + }, + "tokenizers": { + "type": "array", + "items": { + "$ref": "#/definitions/Tokenizer" + }, + "description": "The tokenizers for the index.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search" + } + }, + "tokenFilters": { + "type": "array", + "items": { + "$ref": "#/definitions/TokenFilter" + }, + "description": "The token filters for the index.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search" + } + }, + "charFilters": { + "type": "array", + "items": { + "$ref": "#/definitions/CharFilter" + }, + "description": "The character filters for the index.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search" + } + }, + "@odata.etag": { + "x-ms-client-name": "ETag", + "type": "string", + "description": "The ETag of the index." + } + }, + "required": [ + "name", + "fields" + ], + "description": "Represents an index definition in Azure Search, which describes the fields and search behavior of an index." + }, + "IndexGetStatisticsResult": { + "properties": { + "documentCount": { + "type": "integer", + "format": "int64", + "x-nullable": false, + "readOnly": true, + "description": "The number of documents in the index." + }, + "storageSize": { + "type": "integer", + "format": "int64", + "x-nullable": false, + "readOnly": true, + "description": "The amount of storage in bytes consumed by the index." + } + }, + "description": "Statistics for a given index. Statistics are collected periodically and are not guaranteed to always be up-to-date." + }, + "IndexListResult": { + "properties": { + "value": { + "x-ms-client-name": "Indexes", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/Index" + }, + "description": "The indexes in the Search service." + } + }, + "description": "Response from a List Indexes request. If successful, it includes the full definitions of all indexes." + }, + "Skillset": { + "properties": { + "name": { + "type": "string", + "description": "The name of the skillset." + }, + "description": { + "type": "string", + "description": "The description of the skillset." + }, + "skills": { + "type": "array", + "items": { + "$ref": "#/definitions/Skill" + }, + "description": "A list of skills in the skillset." + }, + "cognitiveServices": { + "$ref": "#/definitions/CognitiveServices", + "description": "Details about cognitive services to be used when running skills." + }, + "@odata.etag": { + "x-ms-client-name": "ETag", + "type": "string", + "description": "The ETag of the skillset." + } + }, + "required": [ + "name", + "description", + "skills" + ], + "externalDocs": { + "url": "https://docs.microsoft.com/azure/search/cognitive-search-tutorial-blob" + }, + "description": "A list of cognitive skills." + }, + "CognitiveServices": { + "discriminator": "@odata.type", + "properties": { + "@odata.type": { + "type": "string" + }, + "description": { + "type": "string" + } + }, + "required": [ + "@odata.type" + ], + "description": "Abstract base class for describing any cognitive service resource attached to the skillset." + }, + "DefaultCognitiveServices": { + "description": "An empty object that represents the default cognitive service resource for a skillset.", + "x-ms-discriminator-value": "#Microsoft.Azure.Search.DefaultCognitiveServices", + "allOf": [ + { + "$ref": "#/definitions/CognitiveServices" + } + ] + }, + "CognitiveServicesByKey": { + "description": "A cognitive service resource provisioned with a key that is attached to a skillset.", + "x-ms-discriminator-value": "#Microsoft.Azure.Search.CognitiveServicesByKey", + "allOf": [ + { + "$ref": "#/definitions/CognitiveServices" + } + ], + "properties": { + "key": { + "type": "string" + } + }, + "required": [ + "key" + ] + }, + "Skill": { + "discriminator": "@odata.type", + "properties": { + "@odata.type": { + "type": "string" + }, + "description": { + "type": "string", + "description": "The description of the skill which describes the inputs, outputs, and usage of the skill." + }, + "context": { + "type": "string", + "description": "Represents the level at which operations take place, such as the document root or document content (for example, /document or /document/content). The default is /document." + }, + "inputs": { + "type": "array", + "items": { + "$ref": "#/definitions/InputFieldMappingEntry" + }, + "description": "Inputs of the skills could be a column in the source data set, or the output of an upstream skill." + }, + "outputs": { + "type": "array", + "items": { + "$ref": "#/definitions/OutputFieldMappingEntry" + }, + "description": "The output of a skill is either a field in an Azure Search index, or a value that can be consumed as an input by another skill." + } + }, + "required": [ + "@odata.type", + "inputs", + "outputs" + ], + "externalDocs": { + "url": "https://docs.microsoft.com/azure/search/cognitive-search-predefined-skills" + }, + "description": "Abstract base class for skills." + }, + "InputFieldMappingEntry": { + "properties": { + "name": { + "type": "string", + "description": "The name of the input." + }, + "source": { + "type": "string", + "description": "The source of the input." + } + }, + "required": [ + "name", + "source" + ], + "description": "Input field mapping for a skill." + }, + "OutputFieldMappingEntry": { + "properties": { + "name": { + "type": "string", + "description": "The name of the output defined by the skill." + }, + "targetName": { + "type": "string", + "description": "The target name of the output. It is optional and default to name." + } + }, + "required": [ + "name" + ], + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/naming-rules" + }, + "description": "Output field mapping for a skill." + }, + "KeyPhraseExtractionSkill": { + "x-ms-discriminator-value": "#Microsoft.Skills.Text.KeyPhraseExtractionSkill", + "allOf": [ + { + "$ref": "#/definitions/Skill" + } + ], + "properties": { + "defaultLanguageCode": { + "$ref": "#/definitions/KeyPhraseExtractionSkillLanguage", + "description": "A value indicating which language code to use. Default is en." + }, + "maxKeyPhraseCount": { + "type": "integer", + "format": "int32", + "x-nullable": true, + "description": "A number indicating how many key phrases to return. If absent, all identified key phrases will be returned." + } + }, + "externalDocs": { + "url": "https://docs.microsoft.com/azure/search/cognitive-search-skill-keyphrases" + }, + "description": "A skill that uses text analytics for key phrase extraction." + }, + "OcrSkill": { + "x-ms-discriminator-value": "#Microsoft.Skills.Vision.OcrSkill", + "allOf": [ + { + "$ref": "#/definitions/Skill" + } + ], + "properties": { + "textExtractionAlgorithm": { + "$ref": "#/definitions/TextExtractionAlgorithm", + "description": "A value indicating which algorithm to use for extracting text. Default is printed." + }, + "defaultLanguageCode": { + "$ref": "#/definitions/OcrSkillLanguage", + "description": "A value indicating which language code to use. Default is en." + }, + "detectOrientation": { + "x-ms-client-name": "ShouldDetectOrientation", + "type": "boolean", + "default": false, + "description": "A value indicating to turn orientation detection on or not. Default is false." + } + }, + "externalDocs": { + "url": "https://docs.microsoft.com/azure/search/cognitive-search-skill-ocr" + }, + "description": "A skill that extracts text from image files." + }, + "ImageAnalysisSkill": { + "x-ms-discriminator-value": "#Microsoft.Skills.Vision.ImageAnalysisSkill", + "allOf": [ + { + "$ref": "#/definitions/Skill" + } + ], + "properties": { + "defaultLanguageCode": { + "$ref": "#/definitions/ImageAnalysisSkillLanguage", + "description": "A value indicating which language code to use. Default is en." + }, + "visualFeatures": { + "type": "array", + "items": { + "$ref": "#/definitions/VisualFeature", + "x-nullable": false + }, + "description": "A list of visual features." + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/ImageDetail", + "x-nullable": false + }, + "description": "A string indicating which domain-specific details to return." + } + }, + "externalDocs": { + "url": "https://docs.microsoft.com/azure/search/cognitive-search-skill-image-analysis" + }, + "description": "A skill that analyzes image files. It extracts a rich set of visual features based on the image content." + }, + "LanguageDetectionSkill": { + "x-ms-discriminator-value": "#Microsoft.Skills.Text.LanguageDetectionSkill", + "allOf": [ + { + "$ref": "#/definitions/Skill" + } + ], + "externalDocs": { + "url": "https://docs.microsoft.com/azure/search/cognitive-search-skill-language-detection" + }, + "description": "A skill that detects the language of input text and reports a single language code for every document submitted on the request. The language code is paired with a score indicating the confidence of the analysis." + }, + "ShaperSkill": { + "x-ms-discriminator-value": "#Microsoft.Skills.Util.ShaperSkill", + "allOf": [ + { + "$ref": "#/definitions/Skill" + } + ], + "externalDocs": { + "url": "https://docs.microsoft.com/azure/search/cognitive-search-skill-shaper" + }, + "description": "A skill for reshaping the outputs. It creates a complex type to support composite fields (also known as multipart fields)." + }, + "MergeSkill": { + "x-ms-discriminator-value": "#Microsoft.Skills.Text.MergeSkill", + "allOf": [ + { + "$ref": "#/definitions/Skill" + } + ], + "properties": { + "insertPreTag": { + "type": "string", + "default": " ", + "description": "The tag indicates the start of the merged text. By default, the tag is an empty space." + }, + "insertPostTag": { + "type": "string", + "default": " ", + "description": "The tag indicates the end of the merged text. By default, the tag is an empty space." + } + }, + "externalDocs": { + "url": "https://docs.microsoft.com/azure/search/cognitive-search-skill-textmerger" + }, + "description": "A skill for merging two or more strings into a single unified string, with an optional user-defined delimiter separating each component part." + }, + "EntityRecognitionSkill": { + "x-ms-discriminator-value": "#Microsoft.Skills.Text.EntityRecognitionSkill", + "allOf": [ + { + "$ref": "#/definitions/Skill" + } + ], + "properties": { + "categories": { + "type": "array", + "items": { + "$ref": "#/definitions/EntityCategory", + "x-nullable": false + }, + "description": "A list of entity categories that should be extracted." + }, + "defaultLanguageCode": { + "$ref": "#/definitions/EntityRecognitionSkillLanguage", + "description": "A value indicating which language code to use. Default is en." + }, + "includeTypelessEntities": { + "type": "boolean", + "x-nullable": true, + "description": "Determines whether or not to include entities which are well known but don't conform to a pre-defined type. If this configuration is not set (default), set to null or set to false, entities which don't conform to one of the pre-defined types will not be surfaced." + }, + "minimumPrecision": { + "type": "number", + "format": "double", + "x-nullable": true, + "description": "A value between 0 and 1 that be used to only include entities whose confidence score is greater than the value specified. If not set (default), or if explicitly set to null, all entities will be included." + } + }, + "externalDocs": { + "url": "https://docs.microsoft.com/azure/search/cognitive-search-skill-entity-recognition" + }, + "description": "Text analytics entity recognition." + }, + "NamedEntityRecognitionSkill": { + "x-ms-discriminator-value": "#Microsoft.Skills.Text.NamedEntityRecognitionSkill", + "allOf": [ + { + "$ref": "#/definitions/Skill" + } + ], + "properties": { + "categories": { + "type": "array", + "items": { + "$ref": "#/definitions/NamedEntityCategory", + "x-nullable": false + }, + "description": "A list of named entity categories." + }, + "defaultLanguageCode": { + "$ref": "#/definitions/NamedEntityRecognitionSkillLanguage", + "description": "A value indicating which language code to use. Default is en." + }, + "minimumPrecision": { + "type": "number", + "format": "double", + "x-nullable": true, + "description": "A value between 0 and 1 to indicate the confidence of the results." + } + }, + "externalDocs": { + "url": "https://docs.microsoft.com/azure/search/cognitive-search-skill-named-entity-recognition" + }, + "description": "Text analytics named entity recognition. This skill is deprecated in favor of EntityRecognitionSkill.", + "x-ms-external": true + }, + "SentimentSkill": { + "x-ms-discriminator-value": "#Microsoft.Skills.Text.SentimentSkill", + "allOf": [ + { + "$ref": "#/definitions/Skill" + } + ], + "properties": { + "defaultLanguageCode": { + "$ref": "#/definitions/SentimentSkillLanguage", + "description": "A value indicating which language code to use. Default is en." + } + }, + "externalDocs": { + "url": "https://docs.microsoft.com/azure/search/cognitive-search-skill-sentiment" + }, + "description": "Text analytics positive-negative sentiment analysis, scored as a floating point value in a range of zero to 1." + }, + "SplitSkill": { + "x-ms-discriminator-value": "#Microsoft.Skills.Text.SplitSkill", + "allOf": [ + { + "$ref": "#/definitions/Skill" + } + ], + "properties": { + "defaultLanguageCode": { + "$ref": "#/definitions/SplitSkillLanguage", + "description": "A value indicating which language code to use. Default is en." + }, + "textSplitMode": { + "$ref": "#/definitions/TextSplitMode", + "x-nullable": false, + "description": "A value indicating which split mode to perform." + }, + "maximumPageLength": { + "type": "integer", + "format": "int32", + "x-nullable": true, + "description": "The desired maximum page length. Default is 10000." + } + }, + "externalDocs": { + "url": "https://docs.microsoft.com/azure/search/cognitive-search-skill-textsplit" + }, + "description": "A skill to split a string into chunks of text." + }, + "WebApiSkill": { + "x-ms-discriminator-value": "#Microsoft.Skills.Custom.WebApiSkill", + "allOf": [ + { + "$ref": "#/definitions/Skill" + } + ], + "properties": { + "uri": { + "type": "string", + "description": "The url for the Web API." + }, + "httpHeaders": { + "$ref": "#/definitions/WebApiHttpHeaders", + "description": "The headers required to make the http request." + }, + "httpMethod": { + "type": "string", + "description": "The method for the http request." + }, + "timeout": { + "type": "string", + "format": "duration", + "description": "The desired timeout for the request. Default is 30 seconds." + }, + "batchSize": { + "type": "integer", + "format": "int32", + "x-nullable": true, + "description": "The desired batch size which indicates number of documents." + } + }, + "required": [ + "uri", + "httpHeaders", + "httpMethod" + ], + "externalDocs": { + "url": "https://docs.microsoft.com/azure/search/cognitive-search-custom-skill-interface" + }, + "description": "A skill that can call a Web API endpoint, allowing you to extend a skillset by having it call your custom code." + }, + "WebApiHttpHeaders": { + "properties": { + "headers": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "A dictionary of http request headers." + } + } + }, + "SkillsetListResult": { + "properties": { + "value": { + "x-ms-client-name": "Skillsets", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/Skillset" + }, + "description": "The skillsets defined in the Search service." + } + }, + "description": "Response from a list Skillset request. If successful, it includes the full definitions of all skillsets." + }, + "TextExtractionAlgorithm": { + "type": "string", + "enum": [ + "printed", + "handwritten" + ], + "x-ms-enum": { + "name": "TextExtractionAlgorithm", + "modelAsString": false + }, + "description": "A value indicating which algorithm to use. Default is printed." + }, + "TextSplitMode": { + "type": "string", + "enum": [ + "pages", + "sentences" + ], + "x-ms-enum": { + "name": "TextSplitMode", + "modelAsString": false + }, + "description": "A value indicating which split mode to perform." + }, + "VisualFeature": { + "type": "string", + "enum": [ + "categories", + "tags", + "description", + "faces", + "imageType", + "color" + ], + "x-ms-enum": { + "name": "VisualFeature", + "modelAsString": false + }, + "description": "The strings indicating what visual feature types to return." + }, + "ImageDetail": { + "type": "string", + "enum": [ + "celebrities", + "landmarks" + ], + "x-ms-enum": { + "name": "ImageDetail", + "modelAsString": false + }, + "description": "A string indicating which domain-specific details to return." + }, + "EntityCategory": { + "type": "string", + "enum": [ + "location", + "organization", + "person", + "quantity", + "datetime", + "url", + "email" + ], + "x-ms-enum": { + "name": "EntityCategory", + "modelAsString": false + }, + "description": "A string indicating what entity categories to return." + }, + "NamedEntityCategory": { + "type": "string", + "enum": [ + "location", + "organization", + "person" + ], + "description": "A string indicating which named entity categories to return.", + "x-ms-external": true + }, + "SentimentSkillLanguage": { + "type": "string", + "enum": [ + "da", + "nl", + "en", + "fi", + "fr", + "de", + "el", + "it", + "no", + "pl", + "pt-PT", + "ru", + "es", + "sv", + "tr" + ], + "x-ms-enum": { + "name": "SentimentSkillLanguage", + "modelAsString": false + }, + "description": "The language codes supported for input text by SentimentSkill." + }, + "KeyPhraseExtractionSkillLanguage": { + "type": "string", + "enum": [ + "da", + "nl", + "en", + "fi", + "fr", + "de", + "it", + "ja", + "ko", + "no", + "pl", + "pt-PT", + "pt-BR", + "ru", + "es", + "sv" + ], + "x-ms-enum": { + "name": "KeyPhraseExtractionSkillLanguage", + "modelAsString": false + }, + "description": "The language codes supported for input text by KeyPhraseExtractionSkill." + }, + "OcrSkillLanguage": { + "type": "string", + "enum": [ + "zh-Hans", + "zh-Hant", + "cs", + "da", + "nl", + "en", + "fi", + "fr", + "de", + "el", + "hu", + "it", + "ja", + "ko", + "nb", + "pl", + "pt", + "ru", + "es", + "sv", + "tr", + "ar", + "ro", + "sr-Cyrl", + "sr-Latn", + "sk" + ], + "x-ms-enum": { + "name": "OcrSkillLanguage", + "modelAsString": false + }, + "description": "The language codes supported for input by OcrSkill." + }, + "SplitSkillLanguage": { + "type": "string", + "enum": [ + "da", + "de", + "en", + "es", + "fi", + "fr", + "it", + "ko", + "pt" + ], + "x-ms-enum": { + "name": "SplitSkillLanguage", + "modelAsString": false + }, + "description": "The language codes supported for input text by SplitSkill." + }, + "EntityRecognitionSkillLanguage": { + "type": "string", + "enum": [ + "de", + "en", + "es", + "fr", + "it" + ], + "x-ms-enum": { + "name": "EntityRecognitionSkillLanguage", + "modelAsString": false + }, + "description": "The language codes supported for input text by EntityRecognitionSkill." + }, + "NamedEntityRecognitionSkillLanguage": { + "type": "string", + "enum": [ + "ar", + "cs", + "da", + "de", + "en", + "es", + "fi", + "fr", + "he", + "hu", + "it", + "ko", + "pt-br", + "pt" + ], + "x-ms-enum": { + "name": "NamedEntityRecognitionSkillLanguage", + "modelAsString": false + }, + "description": "The language codes supported for input text by NamedEntityRecognitionSkill." + }, + "ImageAnalysisSkillLanguage": { + "type": "string", + "enum": [ + "en", + "zh" + ], + "x-ms-enum": { + "name": "ImageAnalysisSkillLanguage", + "modelAsString": false + }, + "description": "The language codes supported for input by ImageAnalysisSkill." + }, + "SynonymMap": { + "properties": { + "name": { + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Naming-rules" + }, + "type": "string", + "description": "The name of the synonym map." + }, + "format": { + "type": "string", + "enum": [ + "solr" + ], + "x-ms-enum": { + "name": "SynonymMapFormat", + "modelAsString": false + }, + "description": "The format of the synonym map. Only the 'solr' format is currently supported." + }, + "synonyms": { + "type": "string", + "description": "A series of synonym rules in the specified synonym map format. The rules must be separated by newlines.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Create-Synonym-Map#SynonymMapFormat" + } + }, + "@odata.etag": { + "x-ms-client-name": "ETag", + "type": "string", + "description": "The ETag of the synonym map." + } + }, + "required": [ + "name", + "format", + "synonyms" + ], + "description": "Represents a synonym map definition in Azure Search." + }, + "SynonymMapListResult": { + "properties": { + "value": { + "x-ms-client-name": "SynonymMaps", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/SynonymMap" + }, + "description": "The synonym maps in the Search service." + } + }, + "description": "Response from a List SynonymMaps request. If successful, it includes the full definitions of all synonym maps." + }, + "ServiceStatistics": { + "properties": { + "counters": { + "$ref": "#/definitions/ServiceCounters", + "description": "Service level resource counters." + }, + "limits": { + "$ref": "#/definitions/ServiceLimits", + "description": "Service level general limits." + } + }, + "description": "Response from a get service statistics request. If successful, it includes service level counters and limits." + }, + "ServiceCounters": { + "properties": { + "documentCount": { + "x-ms-client-name": "documentCounter", + "$ref": "#/definitions/ResourceCounter", + "description": "Total number of documents across all indexes in the service." + }, + "indexesCount": { + "x-ms-client-name": "indexCounter", + "$ref": "#/definitions/ResourceCounter", + "description": "Total number of indexes." + }, + "indexersCount": { + "x-ms-client-name": "indexerCounter", + "$ref": "#/definitions/ResourceCounter", + "description": "Total number of indexers." + }, + "dataSourcesCount": { + "x-ms-client-name": "dataSourceCounter", + "$ref": "#/definitions/ResourceCounter", + "description": "Total number of data sources." + }, + "storageSize": { + "x-ms-client-name": "storageSizeCounter", + "$ref": "#/definitions/ResourceCounter", + "description": "Total size of used storage in bytes." + }, + "synonymMaps": { + "x-ms-client-name": "synonymMapCounter", + "$ref": "#/definitions/ResourceCounter", + "description": "Total number of synonym maps." + } + }, + "description": "Represents service-level resource counters and quotas." + }, + "ServiceLimits": { + "properties": { + "maxFieldsPerIndex": { + "type": "integer", + "format": "int32", + "x-nullable": true, + "description": "The maximum allowed fields per index." + }, + "maxFieldNestingDepthPerIndex": { + "type": "integer", + "format": "int32", + "x-nullable": true, + "description": "The maximum depth which you can nest sub-fields in an index, including the top-level complex field. For example, a/b/c has a nesting depth of 3." + }, + "maxComplexCollectionFieldsPerIndex": { + "type": "integer", + "format": "int32", + "x-nullable": true, + "description": "The maximum number of fields of type Collection(Edm.ComplexType) allowed in an index." + } + }, + "description": "Represents various service level limits." + }, + "ResourceCounter": { + "properties": { + "usage": { + "type": "integer", + "format": "int64", + "x-nullable": false, + "description": "The resource usage amount." + }, + "quota": { + "type": "integer", + "format": "int64", + "x-nullable": true, + "description": "The resource amount quota." + } + }, + "description": "Represents a resource's usage and quota." + } + }, + "parameters": { + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client Api Version." + }, + "ClientRequestIdParameter": { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The tracking ID sent with the request to help with debugging.", + "x-ms-client-request-id": true, + "x-ms-parameter-grouping": { + "name": "search-request-options" + }, + "x-ms-parameter-location": "method" + }, + "IfMatchParameter": { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "Defines the If-Match condition. The operation will be performed only if the ETag on the server matches this value.", + "x-ms-parameter-grouping": { + "name": "access-condition" + }, + "x-ms-parameter-location": "method" + }, + "IfNoneMatchParameter": { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "description": "Defines the If-None-Match condition. The operation will be performed only if the ETag on the server does not match this value.", + "x-ms-parameter-grouping": { + "name": "access-condition" + }, + "x-ms-parameter-location": "method" + }, + "PreferHeaderParameter": { + "name": "Prefer", + "in": "header", + "required": true, + "type": "string", + "enum": [ + "return=representation" + ], + "description": "For HTTP PUT requests, instructs the service to return the created/updated resource on success.", + "x-ms-parameter-location": "method" + }, + "SearchServiceNameParameter": { + "name": "searchServiceName", + "in": "path", + "required": true, + "type": "string", + "x-ms-skip-url-encoding": true, + "description": "The name of the Azure Search service.", + "x-ms-parameter-location": "client" + }, + "SearchDnsSuffixParameter": { + "name": "searchDnsSuffix", + "in": "path", + "required": true, + "type": "string", + "default": "search.windows.net", + "x-ms-skip-url-encoding": true, + "description": "The DNS suffix of the Azure Search service. The default is search.windows.net.", + "x-ms-parameter-location": "client" + } + } +} \ No newline at end of file diff --git a/specification/security/resource-manager/readme.md b/specification/security/resource-manager/readme.md index 4fa9d76a500f..96da02c89fc8 100644 --- a/specification/security/resource-manager/readme.md +++ b/specification/security/resource-manager/readme.md @@ -132,6 +132,7 @@ input-file: - Microsoft.Security/preview/2017-08-01-preview/informationProtectionPolicies.json - Microsoft.Security/preview/2017-08-01-preview/securityContacts.json - Microsoft.Security/preview/2017-08-01-preview/workspaceSettings.json +- Microsoft.Security/preview/2019-01-01-preview/regulatoryCompliance.json # Needed when there is more than one input file override-info: diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/managedInstances.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/managedInstances.json index 99c5289a5f0a..111fb778f6a6 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/managedInstances.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/managedInstances.json @@ -461,8 +461,17 @@ ] }, "proxyOverride": { - "description": "Proxy override of the managed instance.", - "type": "string" + "description": "Connection type used for connecting to the instance.", + "enum": [ + "Proxy", + "Redirect", + "Default" + ], + "type": "string", + "x-ms-enum": { + "name": "ManagedInstanceProxyOverride", + "modelAsString": true + } }, "timezoneId": { "description": "Id of the timezone. Allowed values are timezones supported by Windows.\r\nWindows keeps details on supported timezones, including the id, in registry under\r\nKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion\\Time Zones.\r\nYou can get those registry values via SQL Server by querying SELECT name AS timezone_id FROM sys.time_zone_info.\r\nList of Ids can also be obtained by executing [System.TimeZoneInfo]::GetSystemTimeZones() in PowerShell.\r\nAn example of valid timezone id is \"Pacific Standard Time\" or \"W. Europe Standard Time\".", diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/databases.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/databases.json index 23c8fd393ce1..93d701e5d5d4 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/databases.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/databases.json @@ -200,14 +200,17 @@ }, "x-ms-long-running-operation": true, "x-ms-examples": { - "Creates a database with minimum number of parameters.": { - "$ref": "./examples/CreateDatabaseMin.json" + "Creates a VCore database by specifying service objective name.": { + "$ref": "./examples/CreateVCoreDatabaseByServiceObjective.json" }, - "Creates a VCore database with minimum number of parameters.": { - "$ref": "./examples/CreateVCoreDatabase.json" + "Creates a VCore database by specifying sku name and capacity.": { + "$ref": "./examples/CreateVCoreDatabaseBySkuNameCapacity.json" }, - "Creates a database from restore with database deletion time.": { - "$ref": "./examples/CreateDatabaseRestoreMode.json" + "Creates a data warehouse by specifying service objective name.": { + "$ref": "./examples/CreateDwDatabaseByServiceObjective.json" + }, + "Creates a database with minimum number of parameters.": { + "$ref": "./examples/CreateDatabaseMin.json" }, "Creates a database with default mode.": { "$ref": "./examples/CreateDatabaseDefaultMode.json" @@ -215,14 +218,17 @@ "Creates a database as a copy.": { "$ref": "./examples/CreateDatabaseCopyMode.json" }, - "Creates a database from restore with restorableDroppedDatabaseId.": { - "$ref": "./examples/CreateDatabaseRestoreMode2.json" + "Creates a database as an on-line secondary.": { + "$ref": "./examples/CreateDatabaseSecondaryMode.json" }, "Creates a database from PointInTimeRestore.": { "$ref": "./examples/CreateDatabasePITRMode.json" }, - "Creates a database as an on-line secondary.": { - "$ref": "./examples/CreateDatabaseSecondaryMode.json" + "Creates a database from restore with database deletion time.": { + "$ref": "./examples/CreateDatabaseRestoreMode.json" + }, + "Creates a database from restore with restorableDroppedDatabaseId.": { + "$ref": "./examples/CreateDatabaseRestoreMode2.json" }, "Creates a database from recoverableDatabaseId.": { "$ref": "./examples/CreateDatabaseRecoveryMode.json" @@ -636,7 +642,9 @@ "Pausing", "Paused", "Resuming", - "Scaling" + "Scaling", + "OfflineChangingDwPerformanceTiers", + "OnlineChangingDwPerformanceTiers" ], "type": "string", "readOnly": true, @@ -785,6 +793,16 @@ "$ref": "../../../common/v1/types.json#/definitions/Sku", "description": "The name and tier of the SKU.", "readOnly": true + }, + "autoPauseDelay": { + "format": "int32", + "description": "Time in minutes after which database is automatically paused. A value of -1 means that automatic pause is disabled", + "type": "integer" + }, + "minCapacity": { + "format": "double", + "description": "Minimal capacity that database will always have allocated, if not paused", + "type": "number" } } }, @@ -802,7 +820,7 @@ "properties": { "sku": { "$ref": "../../../common/v1/types.json#/definitions/Sku", - "description": "The name and tier of the SKU." + "description": "The database SKU.\r\n\r\nThe list of SKUs may vary by region and support offer. To determine the SKUs (including the SKU name, tier/edition, family, and capacity) that are available to your subscription in an Azure region, use the `Capabilities_ListByLocation` REST API or one of the following commands:\r\n\r\n```azurecli\r\naz sql db list-editions -l -o table\r\n````\r\n\r\n```powershell\r\nGet-AzSqlServerServiceObjective -Location \r\n````\r\n" }, "kind": { "description": "Kind of database. This is metadata used for the Azure portal experience.", diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/elasticPools.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/elasticPools.json index de76966426fa..ed2ed2d0f9bc 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/elasticPools.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/elasticPools.json @@ -386,7 +386,8 @@ ], "properties": { "sku": { - "$ref": "../../../common/v1/types.json#/definitions/Sku" + "$ref": "../../../common/v1/types.json#/definitions/Sku", + "description": "The elastic pool SKU.\r\n\r\nThe list of SKUs may vary by region and support offer. To determine the SKUs (including the SKU name, tier/edition, family, and capacity) that are available to your subscription in an Azure region, use the `Capabilities_ListByLocation` REST API or the following command:\r\n\r\n```azurecli\r\naz sql elastic-pool list-editions -l -o table\r\n````\r\n" }, "kind": { "description": "Kind of elastic pool. This is metadata used for the Azure portal experience.", diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/examples/CreateDwDatabaseByServiceObjective.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/examples/CreateDwDatabaseByServiceObjective.json new file mode 100644 index 000000000000..50a3936c30f7 --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/examples/CreateDwDatabaseByServiceObjective.json @@ -0,0 +1,80 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "Default-SQL-SouthEastAsia", + "serverName": "testsvr", + "databaseName": "testdw", + "api-version": "2017-03-01-preview", + "parameters": { + "location": "westus", + "sku": { + "name": "DW1000c" + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "DataWarehouse", + "tier": "DataWarehouse", + "capacity": 9000 + }, + "kind": "v12.0,user,datawarehouse,gen2", + "properties": { + "collation": "SQL_Latin1_General_CP1_CI_AS", + "maxSizeBytes": 263882790666240, + "status": "Online", + "databaseId": "188784c9-d602-4684-86cf-e67b6f03551a", + "creationDate": "2019-04-24T06:46:14.99Z", + "currentServiceObjectiveName": "DW1000c", + "requestedServiceObjectiveName": "DW1000c", + "defaultSecondaryLocation": "eastus", + "catalogCollation": "SQL_Latin1_General_CP1_CI_AS", + "readScale": "Disabled", + "currentSku": { + "name": "DataWarehouse", + "tier": "DataWarehouse", + "capacity": 9000 + } + }, + "location": "westus", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/testdw", + "name": "testdw", + "type": "Microsoft.Sql/servers/databases" + } + }, + "201": { + "body": { + "sku": { + "name": "DataWarehouse", + "tier": "DataWarehouse", + "capacity": 9000 + }, + "kind": "v12.0,user,datawarehouse,gen2", + "properties": { + "collation": "SQL_Latin1_General_CP1_CI_AS", + "maxSizeBytes": 263882790666240, + "status": "Online", + "databaseId": "188784c9-d602-4684-86cf-e67b6f03551a", + "creationDate": "2019-04-24T06:46:14.99Z", + "currentServiceObjectiveName": "DW1000c", + "requestedServiceObjectiveName": "DW1000c", + "defaultSecondaryLocation": "eastus", + "catalogCollation": "SQL_Latin1_General_CP1_CI_AS", + "readScale": "Disabled", + "currentSku": { + "name": "DataWarehouse", + "tier": "DataWarehouse", + "capacity": 9000 + } + }, + "location": "westus", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/testdw", + "name": "testdw", + "type": "Microsoft.Sql/servers/databases" + } + }, + "202": {} + } +} \ No newline at end of file diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/examples/CreateVCoreDatabase.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/examples/CreateVCoreDatabase.json deleted file mode 100644 index 1fb0dacdba73..000000000000 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/examples/CreateVCoreDatabase.json +++ /dev/null @@ -1,78 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-1111-2222-3333-444444444444", - "resourceGroupName": "Default-SQL-SouthEastAsia", - "serverName": "testsvr", - "databaseName": "testdb", - "api-version": "2017-03-01-preview", - "parameters": { - "location": "southeastasia", - "sku": { - "name": "BC_Gen4_2", - "tier": "BusinessCritical", - "capacity": 2 - }, - "properties": { - "createMode": "Default", - "collation": "SQL_Latin1_General_CP1_CI_AS", - "maxSizeBytes": 1073741824, - "licenseType": "LicenseIncluded" - } - } - }, - "responses": { - "200": { - "body": { - "sku": { - "name": "BC_Gen4_2", - "tier": "BusinessCritical", - "capacity": 2 - }, - "kind": "v12.0,user", - "properties": { - "collation": "SQL_Latin1_General_CP1_CI_AS", - "maxSizeBytes": 1073741824, - "status": "Online", - "databaseId": "6c764297-577b-470f-9af4-96d3d41e2ba3", - "creationDate": "2017-06-07T04:41:33.937Z", - "currentServiceObjectiveName": "BC_Gen4_2", - "defaultSecondaryLocation": "North Europe", - "catalogCollation": "SQL_Latin1_General_CP1_CI_AS", - "licenseType": "LicenseIncluded", - "maxLogSizeBytes": 104857600 - }, - "location": "southeastasia", - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/testdb", - "name": "testdb", - "type": "Microsoft.Sql/servers/databases" - } - }, - "201": { - "body": { - "sku": { - "name": "BC_Gen4_2", - "tier": "BusinessCritical", - "capacity": 2 - }, - "kind": "v12.0,user", - "properties": { - "collation": "SQL_Latin1_General_CP1_CI_AS", - "maxSizeBytes": 1073741824, - "status": "Online", - "databaseId": "6c764297-577b-470f-9af4-96d3d41e2ba3", - "creationDate": "2017-06-07T04:41:33.937Z", - "currentServiceObjectiveName": "BC_Gen4_2", - "defaultSecondaryLocation": "North Europe", - "catalogCollation": "SQL_Latin1_General_CP1_CI_AS", - "licenseType": "LicenseIncluded", - "maxLogSizeBytes": 104857600 - }, - "location": "southeastasia", - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/testdb", - "name": "testdb", - "type": "Microsoft.Sql/servers/databases" - } - }, - "202": { } - } -} \ No newline at end of file diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/examples/CreateVCoreDatabaseByServiceObjective.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/examples/CreateVCoreDatabaseByServiceObjective.json new file mode 100644 index 000000000000..43fb529b314e --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/examples/CreateVCoreDatabaseByServiceObjective.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "Default-SQL-SouthEastAsia", + "serverName": "testsvr", + "databaseName": "testdb", + "api-version": "2017-03-01-preview", + "parameters": { + "location": "southeastasia", + "sku": { + "name": "BC", + "family": "Gen4", + "capacity": 2 + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "BC_Gen4", + "tier": "BusinessCritical", + "family": "Gen4", + "capacity": 2 + }, + "kind": "v12.0,user", + "properties": { + "collation": "SQL_Latin1_General_CP1_CI_AS", + "maxSizeBytes": 1073741824, + "status": "Online", + "databaseId": "6c764297-577b-470f-9af4-96d3d41e2ba3", + "creationDate": "2017-06-07T04:41:33.937Z", + "currentServiceObjectiveName": "BC_Gen4_2", + "defaultSecondaryLocation": "North Europe", + "catalogCollation": "SQL_Latin1_General_CP1_CI_AS", + "licenseType": "LicenseIncluded", + "maxLogSizeBytes": 104857600 + }, + "location": "southeastasia", + "id": + "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/testdb", + "name": "testdb", + "type": "Microsoft.Sql/servers/databases" + } + }, + "201": { + "body": { + "sku": { + "name": "BC_Gen4", + "tier": "BusinessCritical", + "family": "Gen4", + "capacity": 2 + }, + "kind": "v12.0,user", + "properties": { + "collation": "SQL_Latin1_General_CP1_CI_AS", + "maxSizeBytes": 1073741824, + "status": "Online", + "databaseId": "6c764297-577b-470f-9af4-96d3d41e2ba3", + "creationDate": "2017-06-07T04:41:33.937Z", + "currentServiceObjectiveName": "BC_Gen4_2", + "defaultSecondaryLocation": "North Europe", + "catalogCollation": "SQL_Latin1_General_CP1_CI_AS", + "licenseType": "LicenseIncluded", + "maxLogSizeBytes": 104857600 + }, + "location": "southeastasia", + "id": + "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/testdb", + "name": "testdb", + "type": "Microsoft.Sql/servers/databases" + } + }, + "202": {} + } +} \ No newline at end of file diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/examples/CreateVCoreDatabaseBySkuNameCapacity.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/examples/CreateVCoreDatabaseBySkuNameCapacity.json new file mode 100644 index 000000000000..a9e499e9f466 --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/examples/CreateVCoreDatabaseBySkuNameCapacity.json @@ -0,0 +1,73 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "Default-SQL-SouthEastAsia", + "serverName": "testsvr", + "databaseName": "testdb", + "api-version": "2017-03-01-preview", + "parameters": { + "location": "southeastasia", + "sku": { + "name": "BC_Gen4", + "capacity": 2 + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "BC_Gen4", + "tier": "BusinessCritical", + "family": "Gen4", + "capacity": 2 + }, + "kind": "v12.0,user", + "properties": { + "collation": "SQL_Latin1_General_CP1_CI_AS", + "maxSizeBytes": 1073741824, + "status": "Online", + "databaseId": "6c764297-577b-470f-9af4-96d3d41e2ba3", + "creationDate": "2017-06-07T04:41:33.937Z", + "currentServiceObjectiveName": "BC_Gen4_2", + "defaultSecondaryLocation": "North Europe", + "catalogCollation": "SQL_Latin1_General_CP1_CI_AS", + "licenseType": "LicenseIncluded", + "maxLogSizeBytes": 104857600 + }, + "location": "southeastasia", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/testdb", + "name": "testdb", + "type": "Microsoft.Sql/servers/databases" + } + }, + "201": { + "body": { + "sku": { + "name": "BC_Gen4", + "tier": "BusinessCritical", + "family": "Gen4", + "capacity": 2 + }, + "kind": "v12.0,user", + "properties": { + "collation": "SQL_Latin1_General_CP1_CI_AS", + "maxSizeBytes": 1073741824, + "status": "Online", + "databaseId": "6c764297-577b-470f-9af4-96d3d41e2ba3", + "creationDate": "2017-06-07T04:41:33.937Z", + "currentServiceObjectiveName": "BC_Gen4_2", + "defaultSecondaryLocation": "North Europe", + "catalogCollation": "SQL_Latin1_General_CP1_CI_AS", + "licenseType": "LicenseIncluded", + "maxLogSizeBytes": 104857600 + }, + "location": "southeastasia", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/testdb", + "name": "testdb", + "type": "Microsoft.Sql/servers/databases" + } + }, + "202": {} + } +} \ No newline at end of file diff --git a/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/databases.json b/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/databases.json index a5862d292cc4..87bf517c82db 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/databases.json +++ b/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/databases.json @@ -680,7 +680,7 @@ }, "edition":{ "type":"string", - "description":"The edition of the database. The DatabaseEditions enumeration contains all the valid editions. If createMode is NonReadableSecondary or OnlineSecondary, this value is ignored. To see possible values, query the capabilities API (/subscriptions/{subscriptionId}/providers/Microsoft.Sql/locations/{locationID}/capabilities) referred to by operationId: \"Capabilities_ListByLocation.\" or use the Azure CLI command `az sql db list-editions -l westus --query [].name` .", + "description":"The edition of the database. The DatabaseEditions enumeration contains all the valid editions. If createMode is NonReadableSecondary or OnlineSecondary, this value is ignored.\r\n\r\nThe list of SKUs may vary by region and support offer. To determine the SKUs (including the SKU name, tier/edition, family, and capacity) that are available to your subscription in an Azure region, use the `Capabilities_ListByLocation` REST API or one of the following commands:\r\n\r\n```azurecli\r\naz sql db list-editions -l -o table\r\n````\r\n\r\n```powershell\r\nGet-AzSqlServerServiceObjective -Location \r\n````\r\n", "enum":[ "Web", "Business", @@ -692,7 +692,10 @@ "Stretch", "DataWarehouse", "System", - "System2" + "System2", + "GeneralPurpose", + "BusinessCritical", + "Hyperscale" ], "x-ms-enum":{ "name":"DatabaseEdition", @@ -706,7 +709,7 @@ "requestedServiceObjectiveId":{ "type":"string", "format":"uuid", - "description":"The configured service level objective ID of the database. This is the service level objective that is in the process of being applied to the database. Once successfully updated, it will match the value of currentServiceObjectiveId property. If requestedServiceObjectiveId and requestedServiceObjectiveName are both updated, the value of requestedServiceObjectiveId overrides the value of requestedServiceObjectiveName. To see possible values, query the capabilities API (/subscriptions/{subscriptionId}/providers/Microsoft.Sql/locations/{locationID}/capabilities) referred to by operationId: \"Capabilities_ListByLocation.\" or use the Azure CLI command `az sql db list-editions --location --query [].supportedServiceLevelObjectives[].name` ." + "description":"The configured service level objective ID of the database. This is the service level objective that is in the process of being applied to the database. Once successfully updated, it will match the value of currentServiceObjectiveId property. If requestedServiceObjectiveId and requestedServiceObjectiveName are both updated, the value of requestedServiceObjectiveId overrides the value of requestedServiceObjectiveName.\r\n\r\nThe list of SKUs may vary by region and support offer. To determine the service objective ids that are available to your subscription in an Azure region, use the `Capabilities_ListByLocation` REST API." }, "requestedServiceObjectiveName":{ "type":"string", @@ -781,7 +784,7 @@ "modelAsString":true, "name":"ServiceObjectiveName" }, - "description":"The name of the configured service level objective of the database. This is the service level objective that is in the process of being applied to the database. Once successfully updated, it will match the value of serviceLevelObjective property. To see possible values, query the capabilities API (/subscriptions/{subscriptionId}/providers/Microsoft.Sql/locations/{locationID}/capabilities) referred to by operationId: \"Capabilities_ListByLocation.\" or use the Azure CLI command `az sql db list-editions --location --query [].supportedServiceLevelObjectives[].name` ." + "description":"The name of the configured service level objective of the database. This is the service level objective that is in the process of being applied to the database. Once successfully updated, it will match the value of serviceLevelObjective property. \r\n\r\nThe list of SKUs may vary by region and support offer. To determine the SKUs (including the SKU name, tier/edition, family, and capacity) that are available to your subscription in an Azure region, use the `Capabilities_ListByLocation` REST API or one of the following commands:\r\n\r\n```azurecli\r\naz sql db list-editions -l -o table\r\n````\r\n\r\n```powershell\r\nGet-AzSqlServerServiceObjective -Location \r\n````\r\n" }, "serviceLevelObjective":{ "readOnly":true, diff --git a/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/elasticPools.json b/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/elasticPools.json index 50765eccb344..f7e983f98a9f 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/elasticPools.json +++ b/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/elasticPools.json @@ -289,7 +289,9 @@ "enum":[ "Basic", "Standard", - "Premium" + "Premium", + "GeneralPurpose", + "BusinessCritical" ], "x-ms-enum":{ "name":"ElasticPoolEdition", diff --git a/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/examples/DatabasePause.json b/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/examples/DatabasePause.json index f5014bd987d9..e478bb40abed 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/examples/DatabasePause.json +++ b/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/examples/DatabasePause.json @@ -8,10 +8,8 @@ }, "responses": { "200": { - "body": { } }, "202": { - "body": { } } } } \ No newline at end of file diff --git a/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/examples/DatabaseResume.json b/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/examples/DatabaseResume.json index f5014bd987d9..e478bb40abed 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/examples/DatabaseResume.json +++ b/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/examples/DatabaseResume.json @@ -8,10 +8,8 @@ }, "responses": { "200": { - "body": { } }, "202": { - "body": { } } } } \ No newline at end of file diff --git a/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/examples/ElasticPoolDelete.json b/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/examples/ElasticPoolDelete.json index dc50e297bf3d..d3edd853cb5d 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/examples/ElasticPoolDelete.json +++ b/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/examples/ElasticPoolDelete.json @@ -10,9 +10,6 @@ "200": { "body": "" }, - "202": { - "body": "" - }, "204": { "body": "" } diff --git a/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/importExport.json b/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/importExport.json index 7eebc842a158..a235297f079f 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/importExport.json +++ b/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/importExport.json @@ -304,7 +304,7 @@ }, "edition": { "type": "string", - "description": "The edition for the database being created.", + "description": "The edition for the database being created.\r\n\r\nThe list of SKUs may vary by region and support offer. To determine the SKUs (including the SKU name, tier/edition, family, and capacity) that are available to your subscription in an Azure region, use the `Capabilities_ListByLocation` REST API or one of the following commands:\r\n\r\n```azurecli\r\naz sql db list-editions -l -o table\r\n````\r\n\r\n```powershell\r\nGet-AzSqlServerServiceObjective -Location \r\n````\r\n", "enum": [ "Web", "Business", @@ -316,7 +316,10 @@ "Stretch", "DataWarehouse", "System", - "System2" + "System2", + "GeneralPurpose", + "BusinessCritical", + "Hyperscale" ], "x-ms-enum": { "name": "DatabaseEdition", diff --git a/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/recommendedElasticPools.json b/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/recommendedElasticPools.json index 784ade68f7ab..ce478290ff11 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/recommendedElasticPools.json +++ b/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/recommendedElasticPools.json @@ -175,7 +175,9 @@ "enum": [ "Basic", "Standard", - "Premium" + "Premium", + "GeneralPurpose", + "BusinessCritical" ], "x-ms-enum": { "name": "ElasticPoolEdition", diff --git a/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/recommendedElasticPoolsDecoupled.json b/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/recommendedElasticPoolsDecoupled.json index 70fa552db7eb..060588a9c56d 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/recommendedElasticPoolsDecoupled.json +++ b/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/recommendedElasticPoolsDecoupled.json @@ -175,7 +175,9 @@ "enum": [ "Basic", "Standard", - "Premium" + "Premium", + "GeneralPurpose", + "BusinessCritical" ], "x-ms-enum": { "name": "ElasticPoolEdition", diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2018-03-01-preview/examples/BlobContainersLease_Acquire.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2018-03-01-preview/examples/BlobContainersLease_Acquire.json index 2adf9b52f08c..bb8b046aa4d3 100644 --- a/specification/storage/resource-manager/Microsoft.Storage/preview/2018-03-01-preview/examples/BlobContainersLease_Acquire.json +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2018-03-01-preview/examples/BlobContainersLease_Acquire.json @@ -7,24 +7,17 @@ "api-version": "2018-03-01-preview", "monitor": "true", "parameters": { - "properties": { - "Action": 0, - "LeaseId": null, - "BreakPeriod": null, - "LeaseDuration": -1, - "ProposedLeaseId": null - } + "action": "Acquire", + "leaseId": null, + "breakPeriod": null, + "leaseDuration": -1, + "proposedLeaseId": null } }, "responses": { "200": { "body": { - "id": "/subscriptions/{subscription-id}/resourceGroups/res3376/providers/Microsoft.Storage/storageAccounts/sto328/blobServices/default/containers/container6185", - "name": "container6185", - "type": "Microsoft.Storage/storageAccounts/blobServices/containers", - "properties": { - "LeaseId": "8698f513-fa75-44a1-b8eb-30ba336af27d" - } + "leaseId": "8698f513-fa75-44a1-b8eb-30ba336af27d" } } } diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2018-03-01-preview/examples/BlobContainersLease_Break.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2018-03-01-preview/examples/BlobContainersLease_Break.json index e14bdc92d3b3..418c63ed1bdb 100644 --- a/specification/storage/resource-manager/Microsoft.Storage/preview/2018-03-01-preview/examples/BlobContainersLease_Break.json +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2018-03-01-preview/examples/BlobContainersLease_Break.json @@ -7,24 +7,17 @@ "api-version": "2018-03-01-preview", "monitor": "true", "parameters": { - "properties": { - "Action": 4, - "LeaseId": "8698f513-fa75-44a1-b8eb-30ba336af27d", - "BreakPeriod": null, - "LeaseDuration": null, - "ProposedLeaseId": null - } + "action": "Break", + "leaseId": "8698f513-fa75-44a1-b8eb-30ba336af27d", + "breakPeriod": null, + "leaseDuration": null, + "proposedLeaseId": null } }, "responses": { "200": { "body": { - "id": "/subscriptions/{subscription-id}/resourceGroups/res3376/providers/Microsoft.Storage/storageAccounts/sto328/blobServices/default/containers/container6185", - "name": "container6185", - "type": "Microsoft.Storage/storageAccounts/blobServices/containers", - "properties": { - "LeaseTimeSeconds": "0" - } + "leaseTimeSeconds": "0" } } } diff --git a/specification/storage/resource-manager/Microsoft.Storage/stable/2018-07-01/examples/BlobContainersLease_Acquire.json b/specification/storage/resource-manager/Microsoft.Storage/stable/2018-07-01/examples/BlobContainersLease_Acquire.json index 18c697021828..03d7d9e857bf 100644 --- a/specification/storage/resource-manager/Microsoft.Storage/stable/2018-07-01/examples/BlobContainersLease_Acquire.json +++ b/specification/storage/resource-manager/Microsoft.Storage/stable/2018-07-01/examples/BlobContainersLease_Acquire.json @@ -7,24 +7,17 @@ "api-version": "2018-07-01", "monitor": "true", "parameters": { - "properties": { - "Action": 0, - "LeaseId": null, - "BreakPeriod": null, - "LeaseDuration": -1, - "ProposedLeaseId": null - } + "action": "Acquire", + "leaseId": null, + "breakPeriod": null, + "leaseDuration": -1, + "proposedLeaseId": null } }, "responses": { "200": { "body": { - "id": "/subscriptions/{subscription-id}/resourceGroups/res3376/providers/Microsoft.Storage/storageAccounts/sto328/blobServices/default/containers/container6185", - "name": "container6185", - "type": "Microsoft.Storage/storageAccounts/blobServices/containers", - "properties": { - "LeaseId": "8698f513-fa75-44a1-b8eb-30ba336af27d" - } + "leaseId": "8698f513-fa75-44a1-b8eb-30ba336af27d" } } } diff --git a/specification/storage/resource-manager/Microsoft.Storage/stable/2018-07-01/examples/BlobContainersLease_Break.json b/specification/storage/resource-manager/Microsoft.Storage/stable/2018-07-01/examples/BlobContainersLease_Break.json index e14bdc92d3b3..d0a97bce588d 100644 --- a/specification/storage/resource-manager/Microsoft.Storage/stable/2018-07-01/examples/BlobContainersLease_Break.json +++ b/specification/storage/resource-manager/Microsoft.Storage/stable/2018-07-01/examples/BlobContainersLease_Break.json @@ -4,27 +4,20 @@ "resourceGroupName": "res3376", "accountName": "sto328", "containerName": "container6185", - "api-version": "2018-03-01-preview", + "api-version": "2018-07-01", "monitor": "true", "parameters": { - "properties": { - "Action": 4, - "LeaseId": "8698f513-fa75-44a1-b8eb-30ba336af27d", - "BreakPeriod": null, - "LeaseDuration": null, - "ProposedLeaseId": null - } + "action": "Break", + "leaseId": "8698f513-fa75-44a1-b8eb-30ba336af27d", + "breakPeriod": null, + "leaseDuration": null, + "proposedLeaseId": null } }, "responses": { "200": { "body": { - "id": "/subscriptions/{subscription-id}/resourceGroups/res3376/providers/Microsoft.Storage/storageAccounts/sto328/blobServices/default/containers/container6185", - "name": "container6185", - "type": "Microsoft.Storage/storageAccounts/blobServices/containers", - "properties": { - "LeaseTimeSeconds": "0" - } + "leaseTimeSeconds": "0" } } } diff --git a/specification/storage/resource-manager/Microsoft.Storage/stable/2018-11-01/examples/BlobContainersLease_Acquire.json b/specification/storage/resource-manager/Microsoft.Storage/stable/2018-11-01/examples/BlobContainersLease_Acquire.json index e38f795bdc16..a7d2e6b56976 100644 --- a/specification/storage/resource-manager/Microsoft.Storage/stable/2018-11-01/examples/BlobContainersLease_Acquire.json +++ b/specification/storage/resource-manager/Microsoft.Storage/stable/2018-11-01/examples/BlobContainersLease_Acquire.json @@ -7,24 +7,17 @@ "api-version": "2018-11-01", "monitor": "true", "parameters": { - "properties": { - "Action": 0, - "LeaseId": null, - "BreakPeriod": null, - "LeaseDuration": -1, - "ProposedLeaseId": null - } + "action": "Acquire", + "leaseId": null, + "breakPeriod": null, + "leaseDuration": -1, + "proposedLeaseId": null } }, "responses": { "200": { "body": { - "id": "/subscriptions/{subscription-id}/resourceGroups/res3376/providers/Microsoft.Storage/storageAccounts/sto328/blobServices/default/containers/container6185", - "name": "container6185", - "type": "Microsoft.Storage/storageAccounts/blobServices/containers", - "properties": { - "LeaseId": "8698f513-fa75-44a1-b8eb-30ba336af27d" - } + "leaseId": "8698f513-fa75-44a1-b8eb-30ba336af27d" } } } diff --git a/specification/storage/resource-manager/Microsoft.Storage/stable/2018-11-01/examples/BlobContainersLease_Break.json b/specification/storage/resource-manager/Microsoft.Storage/stable/2018-11-01/examples/BlobContainersLease_Break.json index e14bdc92d3b3..54ef93b1f6e3 100644 --- a/specification/storage/resource-manager/Microsoft.Storage/stable/2018-11-01/examples/BlobContainersLease_Break.json +++ b/specification/storage/resource-manager/Microsoft.Storage/stable/2018-11-01/examples/BlobContainersLease_Break.json @@ -4,27 +4,20 @@ "resourceGroupName": "res3376", "accountName": "sto328", "containerName": "container6185", - "api-version": "2018-03-01-preview", + "api-version": "2018-11-01", "monitor": "true", "parameters": { - "properties": { - "Action": 4, - "LeaseId": "8698f513-fa75-44a1-b8eb-30ba336af27d", - "BreakPeriod": null, - "LeaseDuration": null, - "ProposedLeaseId": null - } + "action": "Break", + "leaseId": "8698f513-fa75-44a1-b8eb-30ba336af27d", + "breakPeriod": null, + "leaseDuration": null, + "proposedLeaseId": null } }, "responses": { "200": { "body": { - "id": "/subscriptions/{subscription-id}/resourceGroups/res3376/providers/Microsoft.Storage/storageAccounts/sto328/blobServices/default/containers/container6185", - "name": "container6185", - "type": "Microsoft.Storage/storageAccounts/blobServices/containers", - "properties": { - "LeaseTimeSeconds": "0" - } + "leaseTimeSeconds": "0" } } } diff --git a/specification/storage/resource-manager/Microsoft.Storage/stable/2019-04-01/blob.json b/specification/storage/resource-manager/Microsoft.Storage/stable/2019-04-01/blob.json index d09eefe50e32..966b39d203c0 100644 --- a/specification/storage/resource-manager/Microsoft.Storage/stable/2019-04-01/blob.json +++ b/specification/storage/resource-manager/Microsoft.Storage/stable/2019-04-01/blob.json @@ -688,6 +688,56 @@ } } } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices/default/containers/{containerName}/lease": { + "post": { + "tags": [ + "BlobContainers" + ], + "operationId": "BlobContainers_Lease", + "x-ms-examples": { + "Acquire a lease on a container": { + "$ref": "./examples/BlobContainersLease_Acquire.json" + }, + "Break a lease on a container": { + "$ref": "./examples/BlobContainersLease_Break.json" + } + }, + "description": "The Lease Container operation establishes and manages a lock on a container for delete operations. The lock duration can be 15 to 60 seconds, or can be infinite.", + "parameters": [ + { + "$ref": "./storage.json#/parameters/ResourceGroupName" + }, + { + "$ref": "./storage.json#/parameters/StorageAccountName" + }, + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "parameters", + "in": "body", + "schema": { + "$ref": "#/definitions/LeaseContainerRequest" + }, + "description": "Lease Container request body." + } + ], + "responses": { + "200": { + "description": "OK -- Lease Container operation completed successfully.", + "schema": { + "$ref": "#/definitions/LeaseContainerResponse" + } + } + } + } } }, "definitions": { @@ -1114,6 +1164,54 @@ "allowedHeaders" ], "description": "Specifies a CORS rule for the Blob service." + }, + "LeaseContainerRequest": { + "properties": { + "action": { + "type": "string", + "enum": [ + "Acquire", + "Renew", + "Change", + "Release", + "Break" + ], + "description": "Specifies the lease action. Can be one of the available actions." + }, + "leaseId": { + "type": "string", + "description": "Identifies the lease. Can be specified in any valid GUID string format." + }, + "breakPeriod": { + "type": "integer", + "description": "Optional. For a break action, proposed duration the lease should continue before it is broken, in seconds, between 0 and 60." + }, + "leaseDuration": { + "type": "integer", + "description": "Required for acquire. Specifies the duration of the lease, in seconds, or negative one (-1) for a lease that never expires." + }, + "proposedLeaseId": { + "type": "string", + "description": "Optional for acquire, required for change. Proposed lease ID, in a GUID string format." + } + }, + "required": [ + "action" + ], + "description": "Lease Container request schema." + }, + "LeaseContainerResponse": { + "properties": { + "leaseId": { + "type": "string", + "description": "Returned unique lease ID that must be included with any request to delete the container, or to renew, change, or release the lease." + }, + "leaseTimeSeconds": { + "type": "string", + "description": "Approximate time remaining in the lease period, in seconds." + } + }, + "description": "Lease Container response schema." } }, "parameters": { diff --git a/specification/storage/resource-manager/Microsoft.Storage/stable/2019-04-01/examples/BlobContainersLease_Acquire.json b/specification/storage/resource-manager/Microsoft.Storage/stable/2019-04-01/examples/BlobContainersLease_Acquire.json new file mode 100644 index 000000000000..b12570e9ef7f --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/stable/2019-04-01/examples/BlobContainersLease_Acquire.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res3376", + "accountName": "sto328", + "containerName": "container6185", + "api-version": "2019-04-01", + "monitor": "true", + "parameters": { + "action": "Acquire", + "leaseId": null, + "breakPeriod": null, + "leaseDuration": -1, + "proposedLeaseId": null + } + }, + "responses": { + "200": { + "body": { + "leaseId": "8698f513-fa75-44a1-b8eb-30ba336af27d" + } + } + } +} \ No newline at end of file diff --git a/specification/storage/resource-manager/Microsoft.Storage/stable/2019-04-01/examples/BlobContainersLease_Break.json b/specification/storage/resource-manager/Microsoft.Storage/stable/2019-04-01/examples/BlobContainersLease_Break.json new file mode 100644 index 000000000000..4a786add7ec4 --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/stable/2019-04-01/examples/BlobContainersLease_Break.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res3376", + "accountName": "sto328", + "containerName": "container6185", + "api-version": "2019-04-01", + "monitor": "true", + "parameters": { + "action": "Break", + "leaseId": "8698f513-fa75-44a1-b8eb-30ba336af27d", + "breakPeriod": null, + "leaseDuration": null, + "proposedLeaseId": null + } + }, + "responses": { + "200": { + "body": { + "leaseTimeSeconds": "0" + } + } + } +} \ No newline at end of file diff --git a/specification/storage/resource-manager/readme.csharp.md b/specification/storage/resource-manager/readme.csharp.md index d6d756d8f550..6cb19ad5cb51 100644 --- a/specification/storage/resource-manager/readme.csharp.md +++ b/specification/storage/resource-manager/readme.csharp.md @@ -34,6 +34,10 @@ batch: ApiVersionName: Api2015_06_05 ``` +### Profile: hybrid_2018_03_01 + +These settings apply only when `--profile=hybrid_2018_03_01` is specified on the command line. + ```yaml $(profile)=='hybrid_2018_03_01' namespace: Microsoft.Azure.Management.Profiles.$(profile).Storage output-folder: $(csharp-sdks-folder)/$(profile)/Storage/Management.Storage/Generated @@ -44,6 +48,10 @@ batch: - tag: package-2016-01 ``` +### Profile: profile_2017_03_09 + +These settings apply only when `--profile=profile_2017_03_09` is specified on the command line. + ```yaml $(profile)=='profile_2017_03_09' namespace: Microsoft.Azure.Management.Profiles.$(profile).Storage output-folder: $(csharp-sdks-folder)/$(profile)/Storage/Management.Storage/Generated diff --git a/specification/storage/resource-manager/readme.go.md b/specification/storage/resource-manager/readme.go.md index 38ac970e92ca..2d5776dd8336 100644 --- a/specification/storage/resource-manager/readme.go.md +++ b/specification/storage/resource-manager/readme.go.md @@ -13,6 +13,7 @@ go: ``` yaml $(go) && $(multiapi) batch: + - tag: package-2019-04 - tag: package-2018-11 - tag: package-2018-07 - tag: package-2018-03 @@ -26,6 +27,15 @@ batch: - tag: package-2015-05-preview ``` +### Tag: package-2019-04 and go + +These settings apply only when `--tag=package-2019-04 --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-2019-04' && $(go) +output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2019-04-01/$(namespace) +``` + ### Tag: package-2018-11 and go These settings apply only when `--tag=package-2018-11 --go` is specified on the command line. diff --git a/specification/subscription/resource-manager/readme.csharp.md b/specification/subscription/resource-manager/readme.csharp.md index 46d100eb6fe3..195102b651ea 100644 --- a/specification/subscription/resource-manager/readme.csharp.md +++ b/specification/subscription/resource-manager/readme.csharp.md @@ -34,6 +34,10 @@ batch: ApiVersionName: Api2018_03_01 ``` +### Profile: hybrid_2018_03_01 + +These settings apply only when `--profile=hybrid_2018_03_01` is specified on the command line. + ```yaml $(profile)=='hybrid_2018_03_01' namespace: Microsoft.Azure.Management.Profiles.$(profile).Subscription output-folder: $(csharp-sdks-folder)/$(profile)/Subscription/Management.Subscription/Generated diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/QueryAggregateSeriesPage1.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/QueryAggregateSeriesPage1.json index 7b670c4d1eac..ad812dab5831 100644 --- a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/QueryAggregateSeriesPage1.json +++ b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/QueryAggregateSeriesPage1.json @@ -16,7 +16,6 @@ "inlineVariables": { "Count": { "kind": "aggregate", - "value": null, "filter": null, "aggregation": { "tsx": "count()" diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/QueryAggregateSeriesPage2.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/QueryAggregateSeriesPage2.json index cd530102197b..44bb3630dbb7 100644 --- a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/QueryAggregateSeriesPage2.json +++ b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/QueryAggregateSeriesPage2.json @@ -17,7 +17,6 @@ "inlineVariables": { "Count": { "kind": "aggregate", - "value": null, "filter": null, "aggregation": { "tsx": "count()" diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/QueryGetSeriesPage1.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/QueryGetSeriesPage1.json index ca165a59278c..48589c3c3f6d 100644 --- a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/QueryGetSeriesPage1.json +++ b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/QueryGetSeriesPage1.json @@ -20,7 +20,9 @@ "tsx": "$event.Temperature" }, "filter": null, - "aggregation": null + "aggregation": { + "tsx": "avg($value)" + } } }, "projectedVariables": [ diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/QueryGetSeriesPage2.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/QueryGetSeriesPage2.json index 2f9b420ab300..a39dc39c17a2 100644 --- a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/QueryGetSeriesPage2.json +++ b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/QueryGetSeriesPage2.json @@ -21,7 +21,9 @@ "tsx": "$event.Temperature" }, "filter": null, - "aggregation": null + "aggregation": { + "tsx": "avg($value)" + } } }, "projectedVariables": [ diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/QueryGetSeriesPage3.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/QueryGetSeriesPage3.json index 03d5dece37be..9fa16bd2e2a3 100644 --- a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/QueryGetSeriesPage3.json +++ b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/QueryGetSeriesPage3.json @@ -21,7 +21,9 @@ "tsx": "$event.Temperature" }, "filter": null, - "aggregation": null + "aggregation": { + "tsx": "avg($value)" + } } }, "projectedVariables": [ diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/TypesBatchPut.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/TypesBatchPut.json index 82e75627501d..4c7fc49f7a24 100644 --- a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/TypesBatchPut.json +++ b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/TypesBatchPut.json @@ -11,7 +11,6 @@ "variables": { "EventCount": { "kind": "aggregate", - "value": null, "filter": null, "aggregation": { "tsx": "count()" diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/timeseriesinsights.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/timeseriesinsights.json index d45fafb99781..0b574aba4bd8 100644 --- a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/timeseriesinsights.json +++ b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/timeseriesinsights.json @@ -971,10 +971,10 @@ "$ref": "#/definitions/Tsx" }, "projectedProperties": { - "description": "Projected properties is an array of property names which you want to project. These properties must appear in the events.", + "description": "Projected properties is an array of properties which you want to project. These properties must appear in the events; otherwise, they are not returned.", "type": "array", "items": { - "type": "string" + "$ref": "#/definitions/EventProperty" } } }, @@ -1284,10 +1284,7 @@ "properties": { "get": { "description": "Time series IDs or names of time series instances to return.", - "type": "array", - "items": { - "$ref": "#/definitions/TimeSeriesId" - } + "$ref": "#/definitions/InstancesRequestBatchGetOrDelete" }, "put": { "description": "Time series instances to be created or updated.", @@ -1305,10 +1302,7 @@ }, "delete": { "description": "Time series IDs or names of time series instances to delete.", - "type": "array", - "items": { - "$ref": "#/definitions/TimeSeriesId" - } + "$ref": "#/definitions/InstancesRequestBatchGetOrDelete" } } }, @@ -1320,8 +1314,7 @@ "description": "List of time series IDs of the time series instances to return or delete.", "type": "array", "items": { - "type": "string", - "format": "uuid" + "$ref": "#/definitions/TimeSeriesId" } }, "names": { diff --git a/specification/web/resource-manager/readme.csharp.md b/specification/web/resource-manager/readme.csharp.md index 011e80111f0e..a670d481e417 100644 --- a/specification/web/resource-manager/readme.csharp.md +++ b/specification/web/resource-manager/readme.csharp.md @@ -33,6 +33,10 @@ batch: ApiVersionName: Api2016_08_01 ``` +### Profile: hybrid_2018_03_01 + +These settings apply only when `--profile=hybrid_2018_03_01` is specified on the command line. + ```yaml $(profile)=='hybrid_2018_03_01' namespace: Microsoft.Azure.Management.Profiles.$(profile).WebSites output-folder: $(csharp-sdks-folder)/$(profile)/Websites/Management.Websites/Generated diff --git a/test/linter.js b/test/linter.js deleted file mode 100644 index 550d336df8da..000000000000 --- a/test/linter.js +++ /dev/null @@ -1,151 +0,0 @@ -// Copyright (c) Microsoft Corporation. All rights reserved. -// Licensed under the MIT License. See License in the project root for license information. - -'use strict'; -var - execSync = require('child_process').execSync, - utils = require('./util/utils'), - fs = require('fs'), - literate = require('@microsoft.azure/literate'), - async_io_1 = require("@microsoft.azure/async-io"), - path = require('path'); - -async function readConfigFile(file, tag) { - // autorest configuration type - const msgs = new literate.MessageEmitter(); - msgs.Message.Subscribe((src, each) => console.log(each.Text)); - const cfg = new literate.Configuration("\n> see https://aka.ms/autorest", new literate.DiskFileSystem("readme.md"), async_io_1.ResolveUri(async_io_1.CreateFolderUri(process.cwd()), async_io_1.CreateFileUri(path.resolve(file)) || "."), { - "input-file": [], - }); - return await cfg.CreateView(msgs, true, { tag: tag }); -} - -async function getTagsMapFromConfig(args) { - if (!fs.existsSync(path.resolve(args.file))) { - console.error('config file invalid. cannot read tags from file ' + config); - return null; - } - - const allTags = scanForTags(fs.readFileSync(args.file)); - const result = {}; - for (const each of allTags) { - result[each] = (await readConfigFile(args.file, each))["input-file"]; - } - return result; -} - -function scanForTags(content) { - const result = new Array(); - const rx = /\$\(tag\)(.*)/g; - let match = rx.exec(content); - while (match) { - const vrx = /['"](.*?)['"]/g; - let v = vrx.exec(match[1]); - if (v && v.length && result.indexOf(v[1]) == -1) { - result.push(v[1]); - } - match = rx.exec(content); - } - return result; -} - -async function getTagsFromConfig(config) { - // get hold of all tags and their corresponding input files using the literate config tool - const tagsMap = await getTagsMapFromConfig({ file: config }); - if (tagsMap === null) { - return null; - } - const tags = Object.keys(tagsMap); - - // filter the tags - if (utils.prOnly) { - // get path to the modified files relative to their corresponding md file, need to do this since - // config files have relative paths to the input files - let allModifiedFiles = utils.getFilesChangedInPR(); - allModifiedFiles = allModifiedFiles.map(mfile => { - return mfile.replace(path.dirname(config) + '/', ''); - }); - - // for each tag->files, find if there are any modified files and select those tags - return tags.filter(tag => { - - const tagFiles = (String(tagsMap[tag])).split(','); - // find intersection with the modified files - return tagFiles.filter(tagFile => { - return allModifiedFiles.indexOf(tagFile) > -1; - }).length > 0; - }); - } - return tags; -} - -function execLinterCommand(args) { - var cmd = `npx autorest@2.0.4152 --validation --azure-validator --message-format=json ${args}`.trim(); - console.log(`Executing: ${cmd}`); - var errorsFound = false; - try { - let result = execSync(cmd, { encoding: 'utf8', maxBuffer: 1024 * 1024 * 64 }); - console.error(result); - } catch (err) { - errorsFound = true; - console.error('Linter validation contains error(s)'); - } - - return errorsFound; -} - -describe('AutoRest Linter validation:', function () { - if (utils.prOnly) { - // Useful when debugging a test for a particular swagger. - // Just update the regex. That will return an array of filtered items. - // configsToProcess = ['specification/sql/resource-manager/readme.md']; - let configsToProcess = utils.getConfigFilesChangedInPR(); - for (const config of configsToProcess) { - it(config + ' should honor linter validation rules.', async function () { - - // find all tags in the config file - const tagsToProcess = await getTagsFromConfig(config); - - let errorsFound = false; - - // if no tags found to process, run with the defaults - if (tagsToProcess === null || tagsToProcess.length === 0) { - // no tags found - // this means we need to run validator against the individual - // json files included in the PR - // but in the same directory tree as the config file - const filesChangedInPR = utils.getFilesChangedInPR(); - const configDir = path.dirname(config); - filesChangedInPR.filter(prFile => { - // set any type to string - prFile += ''; - return prFile.startsWith(configDir) && prFile.indexOf('examples') === -1 && prFile.endsWith('.json'); - }).forEach(prFileInConfigFile => { - console.warn(`WARNING: Configuration file not found for file: ${prFileInConfigFile}, running validation rules against it in individual context.`); - errorsFound = execLinterCommand(`--input-file=${prFileInConfigFile}`) && errorsFound; - }); - } - else { - // if tags found, run linter against every single tag - tagsToProcess.forEach((tagToProcess) => { - errorsFound = execLinterCommand(`${config} --tag=${tagToProcess}`) && errorsFound; - }, this); - } - - if(errorsFound == true) { - throw new Error('Linter validation contains error(s)'); - } - - - }); - } - } - else { - // we are not handling pr_only=false case today, - // to enable, we need to write logic to calculate - // all config files in the repo and run linter with - // every tag in the md file; we can get tags each - // config file from getTagsFromCinfig file - console.warn('Cannot run linter in pr_only false mode'); - } -}); diff --git a/test/syntax.js b/test/syntax.ts similarity index 60% rename from test/syntax.js rename to test/syntax.ts index fec45a99754c..bae563bf04da 100644 --- a/test/syntax.js +++ b/test/syntax.ts @@ -1,18 +1,24 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT License. See License in the project root for license information. -'use strict'; var assert = require("assert"), - fs = require('fs'), - path = require('path'), RefParser = require('json-schema-ref-parser'), util = require('util'), - utils = require('./util/utils'); + utils = require('@azure/rest-api-specs-scripts').utils; -var context; +type Context = { + readonly validator: { + readonly validate: (parsedData: unknown, schema: unknown) => unknown + readonly getLastErrors: () => unknown + } + readonly extensionSwaggerSchema: unknown + readonly exampleSchema: unknown +} + +let syntaxContext: Context -// Useful when debugging a test for a particular swagger. +// Useful when debugging a test for a particular swagger. // Just update the regex. That will return an array of filtered items. // utils.swaggers = utils.swaggers.filter(function(item) { // return (item.match(/.*Microsoft.Logic.*2016-06-01.*/ig) !== null); @@ -24,19 +30,19 @@ var context; describe('Azure swagger schema validation:', function () { before(function (done) { - utils.initializeValidator().then((result) => { - context = result; + utils.initializeValidator().then((result: Context) => { + syntaxContext = result; done(); }); - + }); - for (const swagger of utils.swaggers) { + for (const swagger of utils.getSwaggers()) { it(swagger + ' should be a valid Swagger document.', function (done) { - utils.parseJsonFromFile(swagger).then((parsedData)=> { - var valid = context.validator.validate(parsedData, context.extensionSwaggerSchema); + utils.parseJsonFromFile(swagger).then((parsedData: unknown)=> { + var valid = syntaxContext.validator.validate(parsedData, syntaxContext.extensionSwaggerSchema); if (!valid) { - var error = context.validator.getLastErrors(); + var error = syntaxContext.validator.getLastErrors(); throw new Error("Schema validation failed: " + util.inspect(error, { depth: null })); } assert(valid === true); @@ -46,12 +52,12 @@ describe('Azure swagger schema validation:', function () { } describe('Azure x-ms-example schema validation:', function () { - for (const example of utils.examples) { + for (const example of utils.getExamples()) { it('x-ms-examples: ' + example + ' should be a valid x-ms-example.', function (done) { - utils.parseJsonFromFile(example).then((parsedData) => { - var valid = context.validator.validate(parsedData, context.exampleSchema); + utils.parseJsonFromFile(example).then((parsedData: unknown) => { + var valid = syntaxContext.validator.validate(parsedData, syntaxContext.exampleSchema); if (!valid) { - var error = context.validator.getLastErrors(); + var error = syntaxContext.validator.getLastErrors(); throw new Error("Schema validation failed: " + util.inspect(error, { depth: null })); } assert(valid === true); @@ -63,9 +69,9 @@ describe('Azure swagger schema validation:', function () { }); describe('External file or url references ("$ref") in a swagger spec:', function () { - for (const swagger of utils.swaggers) { + for (const swagger of utils.getSwaggers()) { it(swagger + ' should be completely resolvable.', function (done) { - RefParser.bundle(swagger, function (bundleErr, bundleResult) { + RefParser.bundle(swagger, function (bundleErr: { readonly message: unknown }, _bundleResult: unknown) { if (bundleErr) { var msg = swagger + ' has references that cannot be resolved. They are as follows: \n' + util.inspect(bundleErr.message, { depth: null }); console.log(msg); diff --git a/test/util/utils.ts b/test/util/utils.ts deleted file mode 100644 index d2ffb4c61d08..000000000000 --- a/test/util/utils.ts +++ /dev/null @@ -1,347 +0,0 @@ -// Copyright (c) Microsoft Corporation. All rights reserved. -// Licensed under the MIT License. See License in the project root for license information. - -import * as tsUtils from '../../scripts/ts-utils' -import * as stringMap from '@ts-common/string-map' -import * as os from 'os' -import * as fs from 'fs-extra' -import * as glob from 'glob' -import * as path from 'path' -const z = require('z-schema') -import * as YAML from 'js-yaml' -import request = require('request') -import * as util from 'util' -import { execSync } from 'child_process' - -const asyncJsonRequest = (url: string) => new Promise((res, rej) => request( - { url, json: true }, - (error: unknown, _: unknown, body: unknown) => error ? rej(error) : res(body) -)); - -export const extensionSwaggerSchemaUrl = "https://raw.githubusercontent.com/Azure/autorest/master/schema/swagger-extensions.json"; -export const swaggerSchemaUrl = "http://json.schemastore.org/swagger-2.0"; -export const swaggerSchemaAltUrl = "http://23.22.16.221/v2/schema.json"; -export const schemaUrl = "http://json-schema.org/draft-04/schema"; -export const exampleSchemaUrl = "https://raw.githubusercontent.com/Azure/autorest/master/schema/example-schema.json"; -export const compositeSchemaUrl = "https://raw.githubusercontent.com/Azure/autorest/master/schema/composite-swagger.json"; - -export const isWindows = (process.platform.lastIndexOf('win') === 0); -export const prOnly = undefined !== process.env['PR_ONLY'] ? process.env['PR_ONLY'] : 'false'; - -export const globPath = path.join(__dirname, '../', '../', '/specification/**/*.json'); -export const swaggers = glob.sync(globPath, { ignore: ['**/examples/**/*.json', '**/quickstart-templates/*.json', '**/schema/*.json'] }); -export const exampleGlobPath = path.join(__dirname, '../', '../', '/specification/**/examples/**/*.json'); -export const examples = glob.sync(exampleGlobPath); -export const readmes = glob.sync(path.join(__dirname, '../', '../', '/specification/**/readme.md')); - -// Remove byte order marker. This catches EF BB BF (the UTF-8 BOM) -// because the buffer-to-string conversion in `fs.readFile()` -// translates it to FEFF, the UTF-16 BOM. -export const stripBOM = function(content: Buffer|string) { - if (Buffer.isBuffer(content)) { - content = content.toString(); - } - if (content.charCodeAt(0) === 0xFEFF || content.charCodeAt(0) === 0xFFFE) { - content = content.slice(1); - } - return content; -}; - -/** - * Parses the json from the given filepath - * @returns {string} clr command - */ -export const parseJsonFromFile = async function(filepath: string) { - const data = await fs.readFile(filepath, { encoding: 'utf8' }); - try { - return YAML.safeLoad(stripBOM(data)); - } catch (error) { - throw new Error(`swagger "${filepath}" is an invalid JSON.\n${util.inspect(error, { depth: null })}`); - } -}; - -/** - * Gets the name of the target branch to which the PR is sent. We are using the environment - * variable provided by travis-ci. It is called TRAVIS_BRANCH. More info can be found here: - * https://docs.travis-ci.com/user/environment-variables/#Default-Environment-Variables - * If the environment variable is undefined then the method returns 'master' as the default value. - * @returns {string} branchName The target branch name. - */ -export const getTargetBranch = function() { - console.log(`@@@@@ process.env['TRAVIS_BRANCH'] - ${process.env['TRAVIS_BRANCH']}`); - let result = process.env['TRAVIS_BRANCH'] || 'master'; - result = result.trim(); - console.log(`>>>>> The target branch is: "${result}".`); - return result; -}; - -/** - * Check out a copy of a branch to a temporary location, execute a function, and then restore the previous state - */ -export const doOnBranch = async function(branch: unknown, func: () => Promise) { - fetchBranch(branch); - const branchSha = resolveRef(`origin/${branch}`); - const tmpDir = path.join(os.tmpdir(), branchSha); - - const currentDir = process.cwd(); - checkoutBranch(branch, tmpDir); - - console.log(`Changing directory and executing the function...`); - process.chdir(tmpDir); - const result = await func(); - - console.log(`Restoring previous directory and deleting secondary working tree...`); - process.chdir(currentDir); - execSync(`rm -rf ${tmpDir}`); - - return result; -} - -/** - * Resolve a ref to its commit hash - */ -export const resolveRef = function(ref: unknown) { - let cmd = `git rev-parse ${ref}`; - console.log(`> ${cmd}`); - return execSync(cmd, { encoding: 'utf8' }).trim(); -} - -/** - * Fetch ref for a branch from the origin - */ -export const fetchBranch = function(branch: unknown) { - let cmds = [ - `git remote -vv`, - `git branch --all`, - `git remote set-branches origin --add ${branch}`, - `git fetch origin ${branch}` - ]; - - console.log(`Fetching branch ${branch} from origin...`); - for (let cmd of cmds) { - console.log(`> ${cmd}`); - execSync(cmd, { encoding: 'utf8', stdio: 'inherit' }); - } -} - -/** - * Checkout a copy of branch to location - */ -export const checkoutBranch = function(ref: unknown, location: unknown) { - let cmd = `git worktree add -f ${location} origin/${ref}`; - console.log(`Checking out a copy of branch ${ref} to ${location}...`); - console.log(`> ${cmd}`); - execSync(cmd, { encoding: 'utf8', stdio: 'inherit' }); -} - -/** - * Gets the name of the source branch from which the PR is sent. - * @returns {string} branchName The source branch name. - */ -export const getSourceBranch = function() { - let cmd = 'git rev-parse --abbrev-ref HEAD'; - let result = process.env['TRAVIS_PULL_REQUEST_BRANCH']; - console.log(`@@@@@ process.env['TRAVIS_PULL_REQUEST_BRANCH'] - ${process.env['TRAVIS_PULL_REQUEST_BRANCH']}`); - if (!result) { - try { - result = execSync(cmd, { encoding: 'utf8' }); - } catch (err) { - console.log(`An error occurred while getting the current branch ${util.inspect(err, { depth: null })}.`); - } - } - result = tsUtils.asNonUndefined(result).trim(); - console.log(`>>>>> The source branch is: "${result}".`); - return result; -}; - -/** - * Gets the PR number. We are using the environment - * variable provided by travis-ci. It is called TRAVIS_PULL_REQUEST. More info can be found here: - * https://docs.travis-ci.com/user/environment-variables/#Convenience-Variables - * @returns {string} PR number or 'undefined'. - */ -export const getPullRequestNumber = function() { - let result = process.env['TRAVIS_PULL_REQUEST']; - console.log(`@@@@@ process.env['TRAVIS_PULL_REQUEST'] - ${process.env['TRAVIS_PULL_REQUEST']}`); - - if (!result) { - result = 'undefined'; - } - - return result; -}; - -/** - * Gets the Repo name. We are using the environment - * variable provided by travis-ci. It is called TRAVIS_REPO_SLUG. More info can be found here: - * https://docs.travis-ci.com/user/environment-variables/#Convenience-Variables - * @returns {string} repo name or 'undefined'. - */ -export const getRepoName = function() { - let result = process.env['TRAVIS_REPO_SLUG']; - console.log(`@@@@@ process.env['TRAVIS_REPO_SLUG'] - ${result}`); - - return result; -}; - -/** - * Gets the source repo name for PR's. We are using the environment - * variable provided by travis-ci. It is called TRAVIS_PULL_REQUEST_SLUG. More info can be found here: - * https://docs.travis-ci.com/user/environment-variables/#Convenience-Variables - * @returns {string} repo name or 'undefined'. - */ -export const getSourceRepoName = function() { - let result = process.env['TRAVIS_PULL_REQUEST_SLUG']; - console.log(`@@@@@ process.env['TRAVIS_PULL_REQUEST_SLUG'] - ${result}`); - - return result; -}; - -// Retrieves Git Repository Url -/** - * Gets the repo URL - * @returns {string} repo URL or 'undefined' - */ -export const getRepoUrl = function() { - let repoName = getRepoName(); - return `https://github.com/${repoName}`; -}; - -// Retrieves the source Git Repository Url -/** - * Gets the repo URL from where the PR originated - * @returns {string} repo URL or 'undefined' - */ -export const getSourceRepoUrl = function() { - let repoName = getSourceRepoName(); - return `https://github.com/${repoName}`; -}; - -export const getTimeStamp = function() { - // We pad each value so that sorted directory listings show the files in chronological order - function pad(number: any): any { - if (number < 10) { - return '0' + number; - } - - return number; - } - - var now = new Date(); - return now.getFullYear() - + pad(now.getMonth() + 1) - + pad(now.getDate()) - + "_" - + pad(now.getHours()) - + pad(now.getMinutes()) - + pad(now.getSeconds()); -} - -/** - * Retrieves list of swagger files to be processed for linting - * @returns {Array} list of files to be processed for linting - */ -export const getConfigFilesChangedInPR = function() { - if (prOnly === 'true') { - let targetBranch, cmd, filesChanged; - try { - targetBranch = getTargetBranch(); - execSync(`git fetch origin ${targetBranch}`); - cmd = `git diff --name-only HEAD $(git merge-base HEAD FETCH_HEAD)`; - filesChanged = execSync(cmd, { encoding: 'utf8' }).split('\n'); - console.log('>>>>> Files changed in this PR are as follows:'); - console.log(filesChanged); - - // traverse up to readme.md files - const configFiles = new Set(); - for (let fileChanged of filesChanged) { - while (fileChanged.startsWith("specification")) { - if (fileChanged.toLowerCase().endsWith("readme.md") && fs.existsSync(fileChanged)) { - configFiles.add(fileChanged); - break; - } - // select parent readme - const parts = fileChanged.split('/'); - parts.pop(); - parts.pop(); - parts.push("readme.md"); - fileChanged = parts.join('/'); - } - } - filesChanged = [...configFiles.values()]; - - console.log('>>>>> Affected configuration files:'); - console.log(filesChanged); - - return filesChanged; - } catch (err) { - throw err; - } - } else { - return swaggers; - } -}; - -/** - * Retrieves list of swagger files to be processed for linting - * @returns {Array} list of files to be processed for linting - */ -export const getFilesChangedInPR = function() { - let result = swaggers; - if (prOnly === 'true') { - let targetBranch, cmd, filesChanged, swaggerFilesInPR; - try { - targetBranch = getTargetBranch(); - execSync(`git fetch origin ${targetBranch}`); - cmd = `git diff --name-only HEAD $(git merge-base HEAD FETCH_HEAD)`; - filesChanged = execSync(cmd, { encoding: 'utf8' }); - console.log('>>>>> Files changed in this PR are as follows:') - console.log(filesChanged); - swaggerFilesInPR = filesChanged.split('\n').filter(function (item: string) { - if (item.match(/.*(json|yaml)$/ig) == null || item.match(/.*specification.*/ig) == null) { - return false; - } - if (item.match(/.*\/examples\/*/ig) !== null) { - return false; - } - if (item.match(/.*\/quickstart-templates\/*/ig) !== null) { - return false; - } - return true; - }); - console.log(`>>>> Number of swaggers found in this PR: ${swaggerFilesInPR.length}`); - - var deletedFiles = swaggerFilesInPR.filter(function (swaggerFile: string) { - return !fs.existsSync(swaggerFile); - }); - console.log('>>>>> Files deleted in this PR are as follows:') - console.log(deletedFiles); - // Remove files that have been deleted in the PR - swaggerFilesInPR = swaggerFilesInPR.filter(function (x: string) { return deletedFiles.indexOf(x) < 0 }); - - result = swaggerFilesInPR; - } catch (err) { - throw err; - } - } - return result; -}; - -/** - * Downloads the remote schemas and initializes the validator with remote references. - * @returns {Object} context Provides the schemas in json format and the validator. - */ -export const initializeValidator = async function() { - const context: stringMap.MutableStringMap = { - extensionSwaggerSchema: await asyncJsonRequest(extensionSwaggerSchemaUrl), - swaggerSchema: await asyncJsonRequest(swaggerSchemaAltUrl), - exampleSchema: await asyncJsonRequest(exampleSchemaUrl), - compositeSchema: await asyncJsonRequest(compositeSchemaUrl) - }; - let validator = new z({ breakOnFirstError: false }); - validator.setRemoteReference(swaggerSchemaUrl, context.swaggerSchema); - validator.setRemoteReference(exampleSchemaUrl, context.exampleSchema); - validator.setRemoteReference(compositeSchemaUrl, context.compositeSchema); - context.validator = validator; - return context; -}; diff --git a/tsconfig.json b/tsconfig.json index e05dca6c434d..0556c9a9cc08 100644 --- a/tsconfig.json +++ b/tsconfig.json @@ -1,7 +1,7 @@ { "compilerOptions": { /* Basic Options */ - "target": "esnext", /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017','ES2018' or 'ESNEXT'. */ + "target": "es2019", /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017','ES2018' or 'ESNEXT'. */ "module": "commonjs", /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */ // "lib": [], /* Specify library files to be included in the compilation. */ // "allowJs": true, /* Allow javascript files to be compiled. */