From fc99fe70a6655c8ebea99eb75caa96089e7204b7 Mon Sep 17 00:00:00 2001 From: Anat Gilenson <53407600+anat-gilenson@users.noreply.github.com> Date: Thu, 5 Aug 2021 12:29:05 +0300 Subject: [PATCH] Merge Microsoft.SecurityInsights-2021-09-01-preview with main (#15529) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Update readme.md (#15381) * signalr: adding the missing `Trace` value (#15455) Fixes #14923 * Fix readme.go.md in compute RP (#14631) * add the missing $ * remove one useless directive * fix * remove the hack for track 2 and add comments for reasons * add one of the directive back to readme.go.md * add some comment to explain this more * fix * [AKS] Merge dev-containerservice-Microsoft.ContainerService-2021-07-01 to master (#15370) * Adds base for updating Microsoft.ContainerService from version stable/2021-05-01 to version 2021-07-01 * Updates readme * Updates API version in new specs and examples * Modify Swagger to fix the problem of automatically generating ugly names in track 2 (#14758) * update swagger to fix track 2 autogenerated naming issue * fix * update readme for sdk generation * fix lint error * Trigger Build * update readme * Improve AKS Swagger documentation (#14957) * Improve AKS Swagger documentation - This change has already been merged in master for the 2021-05-01 API version. * Fix up custom words * aks: replace CloudError with ManagedClusterPodIdentityProvisioningError for AAD pod identity provisioning spec (#15033) * fix: decouple pod identity provisioning error from cloud error * drop extra external mark * fix linting issue * fix reference * Dev containerservice microsoft.container service 2021 07 01: add SecurityProfile (#15035) * Add SecurityProfile to ManagedClusters * spaces * Space * spaces * json formatting * move from params to defs * :) * just another * now with npm * Descriptions update for AKS July API (#15074) * allow disabling of runcommand (#15092) * allow disabling of runcommand * format error * format with example * change enable to disable * Revert "allow disabling of runcommand (#15092)" (#15147) This reverts commit ec3e241a564d21f5ec914f4aa0b59a96ac7ec0d9. * [AKS] Add NATGatewayProfile to 2021-07-01 API (#15154) * [AKS] Add NATGatewayProfile to 2021-07-01 API * Fix linter errors Co-authored-by: Kaiqi Zhang * Add scaleDownMode to agent pool properties (#15124) * add scale down mode * address comments * fix markdown link * update proper api version * Resolve python markdown conflict & fix typo (#15402) * resolve python conflict & fix typo * resolve conflict Co-authored-by: FumingZhang <81607949+FumingZhang@users.noreply.github.com> Co-authored-by: Matthew Christopher Co-authored-by: hbc Co-authored-by: Or Parnes Co-authored-by: Haitao Chen Co-authored-by: Kaiqi Zhang Co-authored-by: Marwan Ahmed Co-authored-by: Arthur Ning <57385816+akning-ms@users.noreply.github.com> * removing business rules(a feature for the future) which was added by … (#15399) * removing business rules(a feature for the future) which was added by mistake. * fixing style issues and a typo * Remove heaths from Search codeowners (#15477) * Delete specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview directory (#15394) - Removing Azure Time Series Insights Preview API from docs as we have GA API since July 2021 and preview API will be depreciated. * [Hub Generated] add missing date-time format specifier across map clients for cleaner codegen with datetime types (#15454) * add missing format date-time across map clients * drop date-time format from quarter forecast date which comes with time but doesn't supply timezone info * KeyVault - /rng response should always return a value on success (#14982) * Make value required for RandomBytes response * format * Fix missing data actions in 7.2-stable, 7.3-preview (#15254) * synapse: adding the configuration for the Go Data Plane SDK (#15263) * AzsAdmin Compute: Fixing powershell generation errors (#15059) * Update to use unique resource names to avoid collisions; Add SubscriptionId to ScaleUnits route * Reverting use of common type apiversion to avoid breaking changes. * Moving ApiVersion back to use common type * Fix Microsoft.Insights go/terraform 'full' package (update activityLogAlerts_API.json) (#15163) * Fix go/terraform package * remove incompatible definitions * Force trigger checks * fix on go package-2021-07 * fix condition * Microsoft.ProviderHub : Update 2021-06-01-preview (#15268) * adding 05-preview for diff * adding 06 preview * Add SystemData support in ProviderHub 2021-06-01-preview version * Tab to spaces + address comment * fixing validation errors * add properties back * Fix readme * Fix swagger * prettier check * Fix json Co-authored-by: Sanjai Ganesh Jeenagiri Co-authored-by: REDMOND\lakshv Co-authored-by: shenshengkafei * add descriptions (#15487) * sync (#15470) * Feature/morazmiz/swagger separation fixes (#15295) * add missing types * change reference to resource and resourceWithEtag * extract userInfo to common file * . * add composite tag * add missing dataConnectorsCheckRequirements * add dataConnectorsCheckRequirements to readme * fix readme * . * fix errors in readme * add missing type * add missing types * . * . * remove changes with resource, resourceWithEtag, new tag * . * remove object * revert userInfo changes * fix true * Alias description change (#15461) * Add isServerVersionAbove32 in CosmosDbMongoDbApi linked service (#15250) * track2 modify redis readme.go.md (#15356) * Update web readme and readme.python (#15488) * Update web readme and readme.python * Update readme * Added defaults to EventGrid.json (#15395) * Deprecate API (#15434) Co-authored-by: Orel Kayam * [Maps] Update the Creator V1 API deprecation notice URL's title (#15480) * [Maps] Add Creator v1 deprecation notice. * [Maps] 'dataSharingLevel' is not available - remove text reference for UDI * Add missing notices * [Maps] Update the v1 creator service deprecation notice link * [Maps] Update Creator v1 deprecation notice's hyperlink title. * Add Threat Intellingence to Stable swagger (#14832) * Add Threat Intellingence to Stable swagger * Fix validation error for sharing parameters * Fix validation * Fix Validation * Fix CloudError in ThreatIntelligence to fix linted error * Resolve Conflict * updating error responses, adding x-ms-long-running-operation (#15368) * Fix S360 bugs for swagger FSPG 2020-02-14-preview API (#15459) * added properties.minorVersion for 2020-02-14-preview API swagger and examples * add geoRedundantBackup and earliestRestoreDate * add geoRedundantBackup and earliestRestoreDate 2 * Updated MaintenanceWindow standbyCount logBackupStorageSku availabilityZone * KustoPool PATCH: Change async response from 201 to 202 according to ARM RPC (#15410) * Change PATCH async response from 201 to 202 according to ARM RPC * Add schema Co-authored-by: Amit Elran * Microsoft.BareMetalInfrastructure: correctly annotate read-only properties with readOnly (#15255) * Microsoft.BareMetalInfrastructure: correctly annotate read-only properties with readOnly * Use multi-api and namespace formats for Go SDK like hanaonazure does * Add userAssignedIdentities property to the Identity section in 2021-05-01 and 2021-06-01-preview (#15296) * [Synapse] - Exclude KQL Scripts APIs for August release (#15511) * [Synapse] - split kqlScripts * Run code style checker * Update artifacts * remove ksqlscriptname Co-authored-by: Dongwei Wang * add aad authentication support (#14461) * update endpoint to v2.1 which supports AAD * add v2.1 changes under new folder v2.1 * CI issues * update swagger version * solving s360 issues in MarketplaceOrdering swagger (#15335) * solving s360 issues in MarketplaceOrdering swagger * Update Agreements.json * Update Agreements.json * Update Agreements.json * Update Agreements.json * Update Agreements.json * Update Agreements.json * Update Agreements.json * Update CancelMarketplaceTerms.json * Update GetAgreementMarketplaceTerms.json * Update GetMarketplaceTerms.json * Update SetMarketplaceTerms.json * Update SignMarketplaceTerms.json * Update SignMarketplaceTerms.json * Update SetMarketplaceTerms.json * Update GetMarketplaceTerms.json * Update GetAgreementMarketplaceTerms.json * Update ListMarketplaceTerms.json * Update Agreements.json * Update Agreements.json * Update readme.md * Update readme.md * Update readme.md * Add Key Vault Extension changes (#15176) * Add Key Vault Extension changes * Update compute.json * Microsoft.IoTSecurity: 2021-09-01-preview (#15491) * Initial Commit for Old Version * Add new API version * Update Operation Ids * Update tags * Update example names Co-authored-by: Orel Kayam Co-authored-by: Zed Lei <59104634+RAY-316@users.noreply.github.com> Co-authored-by: Tom Harvey Co-authored-by: Arcturus Co-authored-by: Kaiqi Zhang Co-authored-by: FumingZhang <81607949+FumingZhang@users.noreply.github.com> Co-authored-by: Matthew Christopher Co-authored-by: hbc Co-authored-by: Or Parnes Co-authored-by: Haitao Chen Co-authored-by: Kaiqi Zhang Co-authored-by: Marwan Ahmed Co-authored-by: Arthur Ning <57385816+akning-ms@users.noreply.github.com> Co-authored-by: ankanjan <58195759+ankanjan@users.noreply.github.com> Co-authored-by: Heath Stewart Co-authored-by: Sandip-Raiyani Co-authored-by: Taras Vozniuk Co-authored-by: Maor Leger Co-authored-by: David Desberg Co-authored-by: travist13 Co-authored-by: Jorge Herrera <69991673+herreraj-ms@users.noreply.github.com> Co-authored-by: diwudd Co-authored-by: Sanjai Ganesh Jeenagiri Co-authored-by: REDMOND\lakshv Co-authored-by: shenshengkafei Co-authored-by: Teddy Todorov Co-authored-by: Phoenix He Co-authored-by: moranraz <59017169+moranraz@users.noreply.github.com> Co-authored-by: navysingla <47647464+navysingla@users.noreply.github.com> Co-authored-by: Guosen Wang Co-authored-by: JiahuiPeng <46921893+804873052@users.noreply.github.com> Co-authored-by: Jiefeng Chen <51037443+BigCat20196@users.noreply.github.com> Co-authored-by: Kevin Mao <88005524+kevinmaoo@users.noreply.github.com> Co-authored-by: orkayam <68549999+orkayam@users.noreply.github.com> Co-authored-by: Orel Kayam Co-authored-by: James Park Co-authored-by: hunngu-ms <63322431+hunngu-ms@users.noreply.github.com> Co-authored-by: rewongmicrosoft <57964114+rewongmicrosoft@users.noreply.github.com> Co-authored-by: xunsun-commits <84804232+xunsun-commits@users.noreply.github.com> Co-authored-by: Amit Elran Co-authored-by: Amit Elran Co-authored-by: Laura Galbraith Co-authored-by: srkakuru <50426366+srkakuru@users.noreply.github.com> Co-authored-by: Dongwei Wang Co-authored-by: Dongwei Wang Co-authored-by: kryalama <66494519+kryalama@users.noreply.github.com> Co-authored-by: alkigel <77278418+alkigel@users.noreply.github.com> Co-authored-by: Micah McKittrick <32313503+mimckitt@users.noreply.github.com> --- .github/issue_assignment.yml | 1 - .github/pull_request_assignment.yml | 20 - CODEOWNERS | 2 +- .../preview/v2.1/examples/track.json | 193 + .../preview/v2.1/swagger.json | 1022 ++++ .../data-plane/Monitor.Exporters/readme.md | 14 + .../preview/2015-12-01-preview/Compute.json | 96 +- .../2015-12-01-preview/PlatformImages.json | 57 +- .../preview/2015-12-01-preview/Quotas.json | 10 +- .../2015-12-01-preview/VMExtensions.json | 57 +- .../preview/2018-02-09/Quotas.json | 15 +- .../2018-07-30-preview/DiskMigrationJobs.json | 55 +- .../preview/2018-07-30-preview/Disks.json | 51 +- .../stable/2020-11-01/Features.json | 131 +- .../stable/2021-01-01/Quotas.json | 121 +- .../stable/2021-03-30/ScaleUnits.json | 87 +- .../2021-03-30/examples/ScaleUnits/Get.json | 3 +- .../stable/2021-04-01/DiskMigrationJobs.json | 24 +- .../stable/2021-04-01/Disks.json | 35 +- .../compute/readme.azsautogen.md | 6 +- .../resource-manager/compute/readme.md | 61 +- .../baremetalinfrastructure.json | 1 + .../resource-manager/readme.go.md | 8 + .../stable/2021-03-01/compute.json | 8 +- .../stable/2021-04-01/compute.json | 8 +- .../compute/resource-manager/readme.go.md | 15 +- .../AgentPoolsCreate_CustomNodeConfig.json | 122 + ...entPoolsCreate_EnableEncryptionAtHost.json | 52 + .../examples/AgentPoolsCreate_EnableFIPS.json | 52 + .../AgentPoolsCreate_EnableUltraSSD.json | 52 + .../examples/AgentPoolsCreate_Ephemeral.json | 56 + .../examples/AgentPoolsCreate_GPUMIG.json | 125 + .../examples/AgentPoolsCreate_OSSKU.json | 125 + .../examples/AgentPoolsCreate_PPG.json | 52 + .../examples/AgentPoolsCreate_Spot.json | 84 + .../examples/AgentPoolsCreate_Update.json | 86 + .../2021-07-01/examples/AgentPoolsDelete.json | 13 + .../2021-07-01/examples/AgentPoolsGet.json | 29 + ...entPoolsGetAgentPoolAvailableVersions.json | 32 + .../examples/AgentPoolsGetUpgradeProfile.json | 28 + .../2021-07-01/examples/AgentPoolsList.json | 29 + .../AgentPoolsUpgradeNodeImageVersion.json | 30 + .../examples/AgentPools_Update.json | 73 + .../ContainerServiceGetOSOptions.json | 28 + ...aintenanceConfigurationsCreate_Update.json | 62 + .../MaintenanceConfigurationsDelete.json | 13 + .../MaintenanceConfigurationsGet.json | 42 + .../MaintenanceConfigurationsList.json | 37 + ...ClustersCreate_EnableEncryptionAtHost.json | 236 + .../ManagedClustersCreate_EnableUltraSSD.json | 236 + .../ManagedClustersCreate_EnabledFIPS.json | 236 + .../ManagedClustersCreate_GPUMIG.json | 263 + .../ManagedClustersCreate_HTTPProxy.json | 260 + ...nagedClustersCreate_ManagedNATGateway.json | 231 + ...agedClustersCreate_NodePublicIPPrefix.json | 236 + .../examples/ManagedClustersCreate_OSSKU.json | 263 + .../examples/ManagedClustersCreate_PPG.json | 236 + .../ManagedClustersCreate_PodIdentity.json | 245 + ...ersCreate_PrivateClusterFQDNSubdomain.json | 246 + ...ustersCreate_PrivateClusterPublicFQDN.json | 250 + ...ManagedClustersCreate_SecurityProfile.json | 227 + .../ManagedClustersCreate_Update.json | 285 + .../ManagedClustersCreate_UpdateWithAHUB.json | 275 + ...stersCreate_UpdateWithEnableAzureRBAC.json | 264 + ...ClustersCreate_UserAssignedNATGateway.json | 198 + .../examples/ManagedClustersDelete.json | 12 + .../examples/ManagedClustersGet.json | 97 + .../ManagedClustersGetAccessProfile.json | 22 + .../ManagedClustersGetUpgradeProfile.json | 49 + .../examples/ManagedClustersList.json | 65 + .../ManagedClustersListByResourceGroup.json | 66 + ...edClustersListClusterCredentialResult.json | 20 + .../ManagedClustersResetAADProfile.json | 18 + ...dClustersResetServicePrincipalProfile.json | 16 + ...agedClustersRotateClusterCertificates.json | 12 + .../examples/ManagedClustersStart.json | 12 + .../examples/ManagedClustersStop.json | 12 + .../examples/ManagedClustersUpdateTags.json | 68 + ...boundNetworkDependenciesEndpointsList.json | 242 + .../PrivateEndpointConnectionsDelete.json | 13 + .../PrivateEndpointConnectionsGet.json | 26 + .../PrivateEndpointConnectionsList.json | 29 + .../PrivateEndpointConnectionsUpdate.json | 33 + .../examples/PrivateLinkResourcesList.json | 25 + .../examples/ResolvePrivateLinkServiceId.json | 18 + .../examples/RunCommandRequest.json | 33 + .../examples/RunCommandResultFailed.json | 25 + .../examples/RunCommandResultSucceed.json | 28 + .../stable/2021-07-01/managedClusters.json | 5109 +++++++++++++++++ .../resource-manager/readme.go.md | 10 + .../resource-manager/readme.java.md | 14 + .../resource-manager/readme.md | 27 +- .../resource-manager/readme.python.md | 11 + .../2018-06-01/entityTypes/LinkedService.json | 4 + .../preview/2020-10-15-preview/EventGrid.json | 6 +- .../preview/2021-06-01-preview/EventGrid.json | 6 +- .../healthcareapis/resource-manager/readme.md | 2 +- .../examples/Locations/Get.json | 25 + .../examples/Locations/List.json | 28 + .../examples/Sensors/Delete.json | 13 + .../examples/Sensors}/DownloadActivation.json | 6 +- .../Sensors}/DownloadResetPassword.json | 6 +- .../examples/Sensors/Get.json | 38 + .../examples/Sensors/IoTHub}/Delete.json | 4 +- .../Sensors/IoTHub}/DownloadActivation.json | 4 +- .../IoTHub}/DownloadResetPassword.json | 4 +- .../examples/Sensors/IoTHub}/Get.json | 17 +- .../examples/Sensors/IoTHub}/List.json | 28 +- .../examples/Sensors/IoTHub}/Put.json | 24 +- .../IoTHub}/TriggerTiPackageUpdate.json | 4 +- .../examples/Sensors/List.json | 66 + .../examples/Sensors/Put.json | 64 + .../Sensors/TriggerTiPackageUpdate.json | 12 + .../examples/Sites}/Delete.json | 5 +- .../examples/Sites/Get.json | 32 + .../examples/Sites/IoTHub}/Delete.json | 2 +- .../examples/Sites/IoTHub}/Get.json | 14 +- .../examples/Sites/IoTHub}/List.json | 16 +- .../examples/Sites/IoTHub}/Put.json | 28 +- .../examples/Sites/List.json | 35 + .../examples/Sites/Put.json | 63 + .../preview/2021-09-01-preview/locations.json | 164 + .../preview/2021-09-01-preview/sensors.json | 869 +++ .../preview/2021-09-01-preview/sites.json | 445 ++ .../iotsecurity/resource-manager/readme.md | 20 + .../preview/7.3-preview/keys.json | 3 + .../preview/7.3-preview/rbac.json | 300 +- .../Microsoft.KeyVault/stable/7.2/rbac.json | 12 + .../preview/2021-03-01-preview/mfe.json | 79 +- .../data-plane/Common/preview/1.0/common.json | 1 + .../data-plane/Creator/preview/2.0/alias.json | 3 + .../Alias/preview/1.0/alias.json | 8 +- .../Dataset/preview/1.0/dataset.json | 8 +- .../preview/1.0/dwgconversion.json | 6 +- .../preview/1.0/featurestate.json | 16 +- .../Tileset/preview/1.0/tileset.json | 6 +- .../Microsoft.Maps/WFS/preview/1.0/wfs.json | 16 +- .../data-plane/Render/preview/2.0/render.json | 3 +- .../Weather/preview/1.0/weather.json | 14 +- .../stable/2015-06-01/Agreements.json | 73 +- .../examples/CancelMarketplaceTerms.json | 5 + .../GetAgreementMarketplaceTerms.json | 5 + .../examples/GetMarketplaceTerms.json | 5 + .../examples/ListMarketplaceTerms.json | 16 +- .../examples/SetMarketplaceTerms.json | 5 + .../examples/SignMarketplaceTerms.json | 5 + .../resource-manager/readme.md | 5 + .../monitor/resource-manager/readme.go.md | 10 +- .../monitor/resource-manager/readme.md | 53 +- .../examples/ServerCreate.json | 17 +- .../ServerCreatePointInTimeRestore.json | 14 +- .../examples/ServerGet.json | 7 +- .../examples/ServerGetWithVnet.json | 8 +- .../examples/ServerList.json | 28 +- .../examples/ServerListByResourceGroup.json | 21 +- .../examples/ServerUpdate.json | 7 +- ...erUpdateWithCustomerMaintenanceWindow.json | 7 +- .../2020-02-14-preview/postgresql.json | 71 +- .../CustomRollouts_CreateOrUpdate.json | 8 + .../examples/CustomRollouts_Get.json | 8 + ...omRollouts_ListByProviderRegistration.json | 16 + .../DefaultRollouts_CreateOrUpdate.json | 16 + .../examples/DefaultRollouts_Get.json | 8 + ...ltRollouts_ListByProviderRegistration.json | 16 + ...ificationRegistrations_CreateOrUpdate.json | 8 + .../NotificationRegistrations_Get.json | 8 + ...istrations_ListByProviderRegistration.json | 16 + .../ProviderRegistrations_CreateOrUpdate.json | 8 + .../examples/ProviderRegistrations_Get.json | 8 + .../examples/ProviderRegistrations_List.json | 8 + ...ourceTypeRegistrations_CreateOrUpdate.json | 51 +- .../ResourceTypeRegistrations_Get.json | 15 +- ...istrations_ListByProviderRegistration.json | 15 +- .../examples/Skus_CreateOrUpdate.json | 10 +- ...CreateOrUpdateNestedResourceTypeFirst.json | 10 +- ...reateOrUpdateNestedResourceTypeSecond.json | 10 +- ...CreateOrUpdateNestedResourceTypeThird.json | 10 +- .../2021-06-01-preview/examples/Skus_Get.json | 8 + .../Skus_GetNestedResourceTypeFirst.json | 8 + .../Skus_GetNestedResourceTypeSecond.json | 8 + .../Skus_GetNestedResourceTypeThird.json | 8 + .../Skus_ListByResourceTypeRegistrations.json | 8 + ...eRegistrationsNestedResourceTypeFirst.json | 8 + ...RegistrationsNestedResourceTypeSecond.json | 8 + ...eRegistrationsNestedResourceTypeThird.json | 8 + .../2021-06-01-preview/providerhub.json | 44 + .../stable/2020-11-20/providerhub.json | 44 + .../preview/2019-11-01-preview/account.json | 369 -- .../BusinessRules_CreateOrUpdate.json | 43 - .../examples/BusinessRules_Delete.json | 24 - .../examples/BusinessRules_Disable.json | 33 - .../examples/BusinessRules_Enable.json | 33 - .../examples/BusinessRules_Get.json | 33 - .../examples/BusinessRules_ListByAccount.json | 36 - ...ResourceSetRuleConfigs_CreateOrUpdate.json | 7 + .../examples/ResourceSetRuleConfigs_Get.json | 4 + .../ResourceSetRuleConfigs_ListByAccount.json | 4 + .../redis/resource-manager/readme.go.md | 10 +- .../preview/2020-08-06-preview/devices.json | 640 --- .../examples/Devices/GetDevice.json | 79 - .../Devices/GetDevicesListForHub.json | 82 - .../GetDevicesListForSubscription.json | 82 - .../IotAlertTypes/GetIoTAlertType.json | 29 - .../IotAlertTypes/GetIoTAlertTypeList.json | 32 - .../examples/IotAlerts/GetIoTAlert.json | 37 - .../examples/IotAlerts/GetIoTAlertList.json | 46 - .../examples/IotDefenderSettings/Delete.json | 10 - .../DownloadManagerActivation.json | 14 - .../examples/IotDefenderSettings/Get.json | 23 - .../examples/IotDefenderSettings/List.json | 26 - .../IotDefenderSettings/PackageDownloads.json | 170 - .../examples/IotDefenderSettings/Put.json | 45 - .../GetIoTRecommendationType.json | 28 - .../GetIoTRecommendationTypeList.json | 31 - .../GetIoTRecommendation.json | 27 - .../GetIoTRecommendationList.json | 34 - .../examples/OnPremiseIotSensors/Get.json | 17 - .../examples/OnPremiseIotSensors/List.json | 26 - .../examples/OnPremiseIotSensors/Put.json | 25 - .../2020-08-06-preview/iotAlertTypes.json | 307 - .../preview/2020-08-06-preview/iotAlerts.json | 289 - .../iotDefenderSettings.json | 587 -- .../iotRecommendationTypes.json | 247 - .../iotRecommendations.json | 233 - .../2020-08-06-preview/iotSensors.json | 528 -- .../preview/2020-08-06-preview/iotSites.json | 260 - .../onPremiseIotSensors.json | 346 -- .../security/resource-manager/readme.md | 54 - .../preview/2019-01-01-preview/Bookmarks.json | 1 + .../preview/2019-01-01-preview/Cases.json | 1 + .../DataConnectorsCheckRequirements.json | 503 ++ .../2019-01-01-preview/OfficeConsents.json | 1 + .../2019-01-01-preview/SecurityInsights.json | 518 +- .../2021-03-01-preview/OnboardingStates.json | 1 + .../preview/2021-03-01-preview/Settings.json | 5 +- .../2021-03-01-preview/dataConnectors.json | 1 + .../2021-03-01-preview/operations.json | 4 +- .../stable/2020-01-01/AlertRules.json | 3 + .../stable/2020-01-01/Bookmarks.json | 1 + .../stable/2020-01-01/DataConnectors.json | 1 + .../stable/2020-01-01/SecurityInsights.json | 9 +- .../stable/2021-04-01/Incidents.json | 85 +- .../stable/2021-04-01/ThreatIntelligence.json | 1183 ++++ .../stable/2021-04-01/Watchlists.json | 1 + .../AppendTagsThreatIntelligence.json | 19 + .../CollectThreatIntelligenceMetrics.json | 44 + .../CreateThreatIntelligence.json | 101 + .../DeleteThreatIntelligence.json | 14 + .../GetThreatIntelligence.json | 77 + .../GetThreatIntelligenceById.json | 44 + .../QueryThreatIntelligence.json | 108 + .../ReplaceTagsThreatIntelligence.json | 53 + .../UpdateThreatIntelligence.json | 102 + .../stable/2021-04-01/operations.json | 5 +- .../resource-manager/common/1.0/types.json | 42 +- .../resource-manager/readme.md | 3 + .../stable/2020-05-01/signalr.json | 3 +- .../LedgerDigestUploads.json | 8 +- .../2019-10-01-preview/subscriptions.json | 2 +- .../stable/2020-09-01/subscriptions.json | 2 +- .../preview/2021-06-01-preview/artifacts.json | 271 - .../2021-06-01-preview/kqlScripts.json | 329 ++ specification/synapse/data-plane/readme.go.md | 12 +- specification/synapse/data-plane/readme.md | 11 + .../examples/CreateOrUpdateWorkspace.json | 34 +- .../KustoPoolDataConnectionsUpdate.json | 2 +- .../examples/KustoPoolDatabasesUpdate.json | 2 +- .../examples/KustoPoolsUpdate.json | 2 +- .../preview/2021-06-01-preview/kustoPool.json | 12 +- .../preview/2021-06-01-preview/workspace.json | 34 +- .../examples/CreateOrUpdateWorkspace.json | 34 +- .../stable/2021-05-01/workspace.json | 34 +- .../examples/AvailabilityGet.json | 34 - .../examples/AvailabilityGetEmpty.json | 11 - .../examples/ColdStoreAvailabilityGet.json | 35 - .../examples/ColdStoreEventSchemaGet.json | 45 - .../ColdStoreQueryAggregateSeriesPage1.json | 62 - .../ColdStoreQueryAggregateSeriesPage2.json | 145 - .../ColdStoreQueryGetEventsPage1.json | 40 - .../ColdStoreQueryGetEventsPage2.json | 87 - .../ColdStoreQueryGetEventsPage3.json | 60 - .../ColdStoreQueryGetEventsPage4.json | 42 - .../ColdStoreQueryGetSeriesPage1.json | 43 - .../ColdStoreQueryGetSeriesPage2.json | 76 - .../ColdStoreQueryGetSeriesPage3.json | 55 - .../examples/EventSchemaGet.json | 44 - .../examples/EventSchemaGetEmpty.json | 19 - .../examples/HierarchiesBatchDeleteByIds.json | 22 - .../HierarchiesBatchDeleteByNames.json | 22 - .../examples/HierarchiesBatchGetByIds.json | 46 - .../examples/HierarchiesBatchGetByNames.json | 46 - .../examples/HierarchiesBatchPut.json | 64 - .../examples/HierarchiesGetPage1.json | 25 - .../examples/HierarchiesGetPage2.json | 26 - .../examples/HierarchiesGetPage3.json | 14 - .../examples/InstancesBatchDeleteByIds.json | 36 - .../examples/InstancesBatchDeleteByNames.json | 30 - .../examples/InstancesBatchGetByIds.json | 47 - .../examples/InstancesBatchGetByNames.json | 44 - .../examples/InstancesBatchPut.json | 42 - .../examples/InstancesBatchUpdate.json | 42 - .../examples/InstancesGetPage1.json | 36 - .../examples/InstancesGetPage2.json | 36 - .../examples/InstancesGetPage3.json | 14 - .../examples/InstancesSuggest.json | 30 - .../examples/ModelSettingsGet.json | 22 - .../examples/ModelSettingsUpdateName.json | 25 - .../examples/QueryAggregateSeriesPage1.json | 61 - .../examples/QueryAggregateSeriesPage2.json | 144 - ...esWithCategoricalInterpolatedVariable.json | 250 - ...ggregateSeriesWithCategoricalVariable.json | 238 - ...ggregateSeriesWithSampleInterpolation.json | 114 - .../examples/QueryGetEventsPage1.json | 39 - .../examples/QueryGetEventsPage2.json | 86 - .../examples/QueryGetEventsPage3.json | 59 - .../examples/QueryGetEventsPage4.json | 41 - .../examples/QueryGetEventsWithTakePage1.json | 40 - .../examples/QueryGetEventsWithTakePage2.json | 86 - .../examples/QueryGetSeriesPage1.json | 42 - .../examples/QueryGetSeriesPage2.json | 75 - .../examples/QueryGetSeriesPage3.json | 54 - .../examples/QueryGetSeriesWithTakePage1.json | 43 - .../examples/QueryGetSeriesWithTakePage2.json | 75 - .../examples/SearchInstancesDefault.json | 48 - .../SearchInstancesExpandHierarchiesOnly.json | 59 - ...InstancesHierarchiesDefaultInputPage1.json | 106 - ...InstancesHierarchiesDefaultInputPage2.json | 77 - ...InstancesHierarchiesDefaultInputPage3.json | 66 - .../examples/SearchInstancesOneLevel.json | 49 - .../examples/SearchInstancesRecursive.json | 58 - .../SearchInstancesUntilChildren.json | 66 - .../examples/TypesBatchDeleteByIds.json | 22 - .../examples/TypesBatchDeleteByNames.json | 22 - .../examples/TypesBatchGetByIds.json | 60 - .../examples/TypesBatchGetByNames.json | 59 - .../examples/TypesBatchPut.json | 90 - .../examples/TypesGetPage1.json | 29 - .../examples/TypesGetPage2.json | 32 - .../examples/TypesGetPage3.json | 14 - .../examples/WarmStoreAvailabilityGet.json | 35 - .../examples/WarmStoreEventSchemaGet.json | 45 - .../WarmStoreQueryAggregateSeriesPage.json | 144 - .../WarmStoreQueryGetEventsPage1.json | 40 - .../WarmStoreQueryGetEventsPage2.json | 87 - .../WarmStoreQueryGetEventsPage3.json | 60 - .../WarmStoreQueryGetEventsPage4.json | 42 - .../WarmStoreQueryGetSeriesPage1.json | 43 - .../WarmStoreQueryGetSeriesPage2.json | 76 - .../WarmStoreQueryGetSeriesPage3.json | 55 - .../timeseriesinsights.json | 2517 -------- specification/web/resource-manager/readme.md | 2 +- .../web/resource-manager/readme.python.md | 11 + 352 files changed, 19054 insertions(+), 13460 deletions(-) create mode 100644 specification/applicationinsights/data-plane/Monitor.Exporters/preview/v2.1/examples/track.json create mode 100644 specification/applicationinsights/data-plane/Monitor.Exporters/preview/v2.1/swagger.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/AgentPoolsCreate_CustomNodeConfig.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/AgentPoolsCreate_EnableEncryptionAtHost.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/AgentPoolsCreate_EnableFIPS.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/AgentPoolsCreate_EnableUltraSSD.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/AgentPoolsCreate_Ephemeral.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/AgentPoolsCreate_GPUMIG.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/AgentPoolsCreate_OSSKU.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/AgentPoolsCreate_PPG.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/AgentPoolsCreate_Spot.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/AgentPoolsCreate_Update.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/AgentPoolsDelete.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/AgentPoolsGet.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/AgentPoolsGetAgentPoolAvailableVersions.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/AgentPoolsGetUpgradeProfile.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/AgentPoolsList.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/AgentPoolsUpgradeNodeImageVersion.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/AgentPools_Update.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ContainerServiceGetOSOptions.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/MaintenanceConfigurationsCreate_Update.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/MaintenanceConfigurationsDelete.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/MaintenanceConfigurationsGet.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/MaintenanceConfigurationsList.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersCreate_EnableEncryptionAtHost.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersCreate_EnableUltraSSD.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersCreate_EnabledFIPS.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersCreate_GPUMIG.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersCreate_HTTPProxy.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersCreate_ManagedNATGateway.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersCreate_NodePublicIPPrefix.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersCreate_OSSKU.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersCreate_PPG.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersCreate_PodIdentity.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersCreate_PrivateClusterFQDNSubdomain.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersCreate_PrivateClusterPublicFQDN.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersCreate_SecurityProfile.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersCreate_Update.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersCreate_UpdateWithAHUB.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersCreate_UpdateWithEnableAzureRBAC.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersCreate_UserAssignedNATGateway.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersDelete.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersGet.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersGetAccessProfile.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersGetUpgradeProfile.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersList.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersListByResourceGroup.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersListClusterCredentialResult.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersResetAADProfile.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersResetServicePrincipalProfile.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersRotateClusterCertificates.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersStart.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersStop.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersUpdateTags.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/OutboundNetworkDependenciesEndpointsList.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/PrivateEndpointConnectionsDelete.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/PrivateEndpointConnectionsGet.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/PrivateEndpointConnectionsList.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/PrivateEndpointConnectionsUpdate.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/PrivateLinkResourcesList.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ResolvePrivateLinkServiceId.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/RunCommandRequest.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/RunCommandResultFailed.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/RunCommandResultSucceed.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/managedClusters.json create mode 100644 specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Locations/Get.json create mode 100644 specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Locations/List.json create mode 100644 specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sensors/Delete.json rename specification/{security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/OnPremiseIotSensors => iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sensors}/DownloadActivation.json (63%) rename specification/{security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/OnPremiseIotSensors => iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sensors}/DownloadResetPassword.json (68%) create mode 100644 specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sensors/Get.json rename specification/{security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotSensors => iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sensors/IoTHub}/Delete.json (73%) rename specification/{security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotSensors => iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sensors/IoTHub}/DownloadActivation.json (79%) rename specification/{security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotSensors => iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sensors/IoTHub}/DownloadResetPassword.json (82%) rename specification/{security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotSensors => iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sensors/IoTHub}/Get.json (62%) rename specification/{security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotSensors => iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sensors/IoTHub}/List.json (62%) rename specification/{security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotSensors => iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sensors/IoTHub}/Put.json (72%) rename specification/{security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotSensors => iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sensors/IoTHub}/TriggerTiPackageUpdate.json (72%) create mode 100644 specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sensors/List.json create mode 100644 specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sensors/Put.json create mode 100644 specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sensors/TriggerTiPackageUpdate.json rename specification/{security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/OnPremiseIotSensors => iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sites}/Delete.json (57%) create mode 100644 specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sites/Get.json rename specification/{security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotSites => iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sites/IoTHub}/Delete.json (83%) rename specification/{security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotSites => iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sites/IoTHub}/Get.json (55%) rename specification/{security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotSites => iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sites/IoTHub}/List.json (50%) rename specification/{security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotSites => iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sites/IoTHub}/Put.json (55%) create mode 100644 specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sites/List.json create mode 100644 specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sites/Put.json create mode 100644 specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/locations.json create mode 100644 specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/sensors.json create mode 100644 specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/sites.json delete mode 100644 specification/purview/data-plane/Azure.Analytics.Purview.Account/preview/2019-11-01-preview/examples/BusinessRules_CreateOrUpdate.json delete mode 100644 specification/purview/data-plane/Azure.Analytics.Purview.Account/preview/2019-11-01-preview/examples/BusinessRules_Delete.json delete mode 100644 specification/purview/data-plane/Azure.Analytics.Purview.Account/preview/2019-11-01-preview/examples/BusinessRules_Disable.json delete mode 100644 specification/purview/data-plane/Azure.Analytics.Purview.Account/preview/2019-11-01-preview/examples/BusinessRules_Enable.json delete mode 100644 specification/purview/data-plane/Azure.Analytics.Purview.Account/preview/2019-11-01-preview/examples/BusinessRules_Get.json delete mode 100644 specification/purview/data-plane/Azure.Analytics.Purview.Account/preview/2019-11-01-preview/examples/BusinessRules_ListByAccount.json delete mode 100644 specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/devices.json delete mode 100644 specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/Devices/GetDevice.json delete mode 100644 specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/Devices/GetDevicesListForHub.json delete mode 100644 specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/Devices/GetDevicesListForSubscription.json delete mode 100644 specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotAlertTypes/GetIoTAlertType.json delete mode 100644 specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotAlertTypes/GetIoTAlertTypeList.json delete mode 100644 specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotAlerts/GetIoTAlert.json delete mode 100644 specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotAlerts/GetIoTAlertList.json delete mode 100644 specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotDefenderSettings/Delete.json delete mode 100644 specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotDefenderSettings/DownloadManagerActivation.json delete mode 100644 specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotDefenderSettings/Get.json delete mode 100644 specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotDefenderSettings/List.json delete mode 100644 specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotDefenderSettings/PackageDownloads.json delete mode 100644 specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotDefenderSettings/Put.json delete mode 100644 specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotRecommendationTypes/GetIoTRecommendationType.json delete mode 100644 specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotRecommendationTypes/GetIoTRecommendationTypeList.json delete mode 100644 specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotRecommendations/GetIoTRecommendation.json delete mode 100644 specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotRecommendations/GetIoTRecommendationList.json delete mode 100644 specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/OnPremiseIotSensors/Get.json delete mode 100644 specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/OnPremiseIotSensors/List.json delete mode 100644 specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/OnPremiseIotSensors/Put.json delete mode 100644 specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/iotAlertTypes.json delete mode 100644 specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/iotAlerts.json delete mode 100644 specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/iotDefenderSettings.json delete mode 100644 specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/iotRecommendationTypes.json delete mode 100644 specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/iotRecommendations.json delete mode 100644 specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/iotSensors.json delete mode 100644 specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/iotSites.json delete mode 100644 specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/onPremiseIotSensors.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/DataConnectorsCheckRequirements.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/ThreatIntelligence.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/examples/threatintelligence/AppendTagsThreatIntelligence.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/examples/threatintelligence/CollectThreatIntelligenceMetrics.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/examples/threatintelligence/CreateThreatIntelligence.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/examples/threatintelligence/DeleteThreatIntelligence.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/examples/threatintelligence/GetThreatIntelligence.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/examples/threatintelligence/GetThreatIntelligenceById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/examples/threatintelligence/QueryThreatIntelligence.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/examples/threatintelligence/ReplaceTagsThreatIntelligence.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/examples/threatintelligence/UpdateThreatIntelligence.json create mode 100644 specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/kqlScripts.json delete mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/AvailabilityGet.json delete mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/AvailabilityGetEmpty.json delete mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/ColdStoreAvailabilityGet.json delete mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/ColdStoreEventSchemaGet.json delete mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/ColdStoreQueryAggregateSeriesPage1.json delete mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/ColdStoreQueryAggregateSeriesPage2.json delete mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/ColdStoreQueryGetEventsPage1.json delete mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/ColdStoreQueryGetEventsPage2.json delete mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/ColdStoreQueryGetEventsPage3.json delete mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/ColdStoreQueryGetEventsPage4.json delete mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/ColdStoreQueryGetSeriesPage1.json delete mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/ColdStoreQueryGetSeriesPage2.json delete mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/ColdStoreQueryGetSeriesPage3.json delete mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/EventSchemaGet.json delete mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/EventSchemaGetEmpty.json delete mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/HierarchiesBatchDeleteByIds.json delete mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/HierarchiesBatchDeleteByNames.json delete mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/HierarchiesBatchGetByIds.json delete mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/HierarchiesBatchGetByNames.json delete mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/HierarchiesBatchPut.json delete mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/HierarchiesGetPage1.json delete mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/HierarchiesGetPage2.json delete mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/HierarchiesGetPage3.json delete mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/InstancesBatchDeleteByIds.json delete mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/InstancesBatchDeleteByNames.json delete mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/InstancesBatchGetByIds.json delete mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/InstancesBatchGetByNames.json delete mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/InstancesBatchPut.json delete mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/InstancesBatchUpdate.json delete mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/InstancesGetPage1.json delete mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/InstancesGetPage2.json delete mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/InstancesGetPage3.json delete mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/InstancesSuggest.json delete mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/ModelSettingsGet.json delete mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/ModelSettingsUpdateName.json delete mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/QueryAggregateSeriesPage1.json delete mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/QueryAggregateSeriesPage2.json delete mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/QueryAggregateSeriesWithCategoricalInterpolatedVariable.json delete mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/QueryAggregateSeriesWithCategoricalVariable.json delete mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/QueryAggregateSeriesWithSampleInterpolation.json delete mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/QueryGetEventsPage1.json delete mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/QueryGetEventsPage2.json delete mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/QueryGetEventsPage3.json delete mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/QueryGetEventsPage4.json delete mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/QueryGetEventsWithTakePage1.json delete mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/QueryGetEventsWithTakePage2.json delete mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/QueryGetSeriesPage1.json delete mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/QueryGetSeriesPage2.json delete mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/QueryGetSeriesPage3.json delete mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/QueryGetSeriesWithTakePage1.json delete mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/QueryGetSeriesWithTakePage2.json delete mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/SearchInstancesDefault.json delete mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/SearchInstancesExpandHierarchiesOnly.json delete mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/SearchInstancesHierarchiesDefaultInputPage1.json delete mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/SearchInstancesHierarchiesDefaultInputPage2.json delete mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/SearchInstancesHierarchiesDefaultInputPage3.json delete mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/SearchInstancesOneLevel.json delete mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/SearchInstancesRecursive.json delete mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/SearchInstancesUntilChildren.json delete mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/TypesBatchDeleteByIds.json delete mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/TypesBatchDeleteByNames.json delete mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/TypesBatchGetByIds.json delete mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/TypesBatchGetByNames.json delete mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/TypesBatchPut.json delete mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/TypesGetPage1.json delete mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/TypesGetPage2.json delete mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/TypesGetPage3.json delete mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/WarmStoreAvailabilityGet.json delete mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/WarmStoreEventSchemaGet.json delete mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/WarmStoreQueryAggregateSeriesPage.json delete mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/WarmStoreQueryGetEventsPage1.json delete mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/WarmStoreQueryGetEventsPage2.json delete mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/WarmStoreQueryGetEventsPage3.json delete mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/WarmStoreQueryGetEventsPage4.json delete mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/WarmStoreQueryGetSeriesPage1.json delete mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/WarmStoreQueryGetSeriesPage2.json delete mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/WarmStoreQueryGetSeriesPage3.json delete mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/timeseriesinsights.json diff --git a/.github/issue_assignment.yml b/.github/issue_assignment.yml index db9ce6dfd4a2..f794ce633f5c 100644 --- a/.github/issue_assignment.yml +++ b/.github/issue_assignment.yml @@ -2,7 +2,6 @@ - rule: booleanFilterExpression: "needs-triage" assignees: - - PhoenixHe-msft - raych1 - akning-ms - leni-msft diff --git a/.github/pull_request_assignment.yml b/.github/pull_request_assignment.yml index 3a053db1e163..4e2b968803f0 100644 --- a/.github/pull_request_assignment.yml +++ b/.github/pull_request_assignment.yml @@ -128,12 +128,6 @@ reviewers: - fengzhou-msft -- rule: - paths: - - "specification/@(containerservice|containerinstance)/**" - reviewers: - - PhoenixHe-msft - - rule: paths: - "specification/mixedreality/**" @@ -141,24 +135,12 @@ reviewers: - leni-msft -- rule: - paths: - - "specification/portal/**" - reviewers: - - PhoenixHe-msft - - rule: paths: - "specification/web/**" reviewers: - weidongxu-microsoft -- rule: - paths: - - "specification/testbase/**" - reviewers: - - PhoenixHe-msft - - rule: paths: - "specification/servicelinker/**" @@ -188,7 +170,6 @@ - ".azure-pipelines-preproduction/**" reviewers: - akning-ms - - PhoenixHe-msft - raych1 - zhenglaizhang @@ -197,7 +178,6 @@ paths: - "**" reviewers: - - PhoenixHe-msft - lirenhe - weidongxu-microsoft - ArcturusZhang diff --git a/CODEOWNERS b/CODEOWNERS index 7d3653ffa9ba..b9c15db2b517 100644 --- a/CODEOWNERS +++ b/CODEOWNERS @@ -62,7 +62,7 @@ /specification/relay/ @sethmanheim @v-ajnava /specification/resources/ @Azure/arm-template-deployments @rajshah11 @vivsriaus /specification/scheduler/ @pinwang81 -/specification/search/data-plane/ @brjohnstmsft @arv100kri @bleroy @heaths @AlexGhiondea @Mohit-Chakraborty +/specification/search/data-plane/ @brjohnstmsft @arv100kri @bleroy @AlexGhiondea @Mohit-Chakraborty /specification/search/resource-manager/ @abhi1509 @tjacobhi /specification/serialconsole/ @amitchat @craigw @asinn826 /specification/service-map/ @daveirwin1 diff --git a/specification/applicationinsights/data-plane/Monitor.Exporters/preview/v2.1/examples/track.json b/specification/applicationinsights/data-plane/Monitor.Exporters/preview/v2.1/examples/track.json new file mode 100644 index 000000000000..dad4cd1bc839 --- /dev/null +++ b/specification/applicationinsights/data-plane/Monitor.Exporters/preview/v2.1/examples/track.json @@ -0,0 +1,193 @@ +{ + "parameters": { + "Host": "{Host}", + "body": [ + { + "ver": 1, + "name": "Microsoft.ApplicationInsights.b4f83947968d4e2f82ad804be07697ae.Event", + "time": "2020-09-22T10:12:53.208-0700", + "sampleRate": 100.0, + "iKey": "c1f83947-938c-5e2a-82ff-804be07647bc", + "tags": { + "ai.internal.sdkVersion": "java:3.0.0-PREVIEW.5", + "ai.internal.nodeName": "MININT-PLOJ2RD", + "ai.operation.id": "f364119ed1ff3bcda0d4ee0896cf785f", + "ai.cloud.roleInstance": "MININT-PLOJ2RD", + "ai.operation.childid": "75706a2ac9456288" + } + }, + { + "ver": 1, + "name": "Microsoft.ApplicationInsights.b4f83947968d4e2f82ad804be07697ae.Event", + "time": "2020-09-22T10:12:53.208-0700", + "sampleRate": 100.0, + "iKey": "c1f83947-938c-5e2a-82ff-804be07647bc", + "tags": { + "ai.internal.sdkVersion": "java:3.0.0-PREVIEW.5", + "ai.internal.nodeName": "MININT-PLOJ2RD", + "ai.operation.id": "f364119ed1ff3bcda0d4ee0896cf785f", + "ai.cloud.roleInstance": "MININT-PLOJ2RD", + "ai.operation.childid": "75706a2ac9456288" + } + }, + { + "ver": 1, + "name": "Microsoft.ApplicationInsights.b4f83947968d4e2f82ad804be07697ae.Event", + "time": "2020-09-22T10:12:53.208-0700", + "sampleRate": 100.0, + "iKey": "c1f83947-938c-5e2a-82ff-804be07647bc", + "tags": { + "ai.internal.sdkVersion": "java:3.0.0-PREVIEW.5", + "ai.internal.nodeName": "MININT-PLOJ2RD", + "ai.operation.id": "f364119ed1ff3bcda0d4ee0896cf785f", + "ai.cloud.roleInstance": "MININT-PLOJ2RD", + "ai.operation.childid": "75706a2ac9456288" + } + }, + { + "ver": 1, + "name": "Microsoft.ApplicationInsights.b4f83947968d4e2f82ad804be07697ae.Event", + "time": "2020-09-22T10:12:53.208-0700", + "sampleRate": 100.0, + "iKey": "c1f83947-938c-5e2a-82ff-804be07647bc", + "tags": { + "ai.internal.sdkVersion": "java:3.0.0-PREVIEW.5", + "ai.internal.nodeName": "MININT-PLOJ2RD", + "ai.operation.id": "f364119ed1ff3bcda0d4ee0896cf785f", + "ai.cloud.roleInstance": "MININT-PLOJ2RD", + "ai.operation.childid": "75706a2ac9456288" + } + }, + { + "ver": 1, + "name": "Microsoft.ApplicationInsights.b4f83947968d4e2f82ad804be07697ae.Event", + "time": "2020-09-22T10:12:53.208-0700", + "sampleRate": 100.0, + "iKey": "c1f83947-938c-5e2a-82ff-804be07647bc", + "tags": { + "ai.internal.sdkVersion": "java:3.0.0-PREVIEW.5", + "ai.internal.nodeName": "MININT-PLOJ2RD", + "ai.operation.id": "f364119ed1ff3bcda0d4ee0896cf785f", + "ai.cloud.roleInstance": "MININT-PLOJ2RD", + "ai.operation.childid": "75706a2ac9456288" + } + }, + { + "ver": 1, + "name": "Microsoft.ApplicationInsights.b4f83947968d4e2f82ad804be07697ae.Event", + "time": "2020-09-22T10:12:53.208-0700", + "sampleRate": 100.0, + "iKey": "c1f83947-938c-5e2a-82ff-804be07647bc", + "tags": { + "ai.internal.sdkVersion": "java:3.0.0-PREVIEW.5", + "ai.internal.nodeName": "MININT-PLOJ2RD", + "ai.operation.id": "f364119ed1ff3bcda0d4ee0896cf785f", + "ai.cloud.roleInstance": "MININT-PLOJ2RD", + "ai.operation.childid": "75706a2ac9456288" + } + }, + { + "ver": 1, + "name": "Microsoft.ApplicationInsights.b4f83947968d4e2f82ad804be07697ae.Event", + "time": "2020-09-22T10:12:53.208-0700", + "sampleRate": 100.0, + "iKey": "c1f83947-938c-5e2a-82ff-804be07647bc", + "tags": { + "ai.internal.sdkVersion": "java:3.0.0-PREVIEW.5", + "ai.internal.nodeName": "MININT-PLOJ2RD", + "ai.operation.id": "f364119ed1ff3bcda0d4ee0896cf785f", + "ai.cloud.roleInstance": "MININT-PLOJ2RD", + "ai.operation.childid": "75706a2ac9456288" + } + } + ] + }, + "responses": { + "200": { + "headers": {}, + "body": { + "itemsReceived": 1, + "itemsAccepted": 1, + "errors": [] + } + }, + "206": { + "headers": {}, + "body": { + "itemsReceived": 1, + "itemsAccepted": 1, + "errors": [] + } + }, + "400": { + "headers": {}, + "body": { + "itemsReceived": 1, + "itemsAccepted": 0, + "errors": [ + { + "index": 1, + "statusCode": 400, + "message": "103: Field 'time' on type 'Envelope' is older than the allowed min date. Expected: now - 172800000ms, Actual: now - 2694990759ms" + } + ] + } + }, + "402": { + "headers": {}, + "body": { + "itemsReceived": 1, + "itemsAccepted": 0, + "errors": [ + { + "index": 1, + "statusCode": 402, + "message": "" + } + ] + } + }, + "429": { + "headers": {}, + "body": { + "itemsReceived": 1, + "itemsAccepted": 0, + "errors": [ + { + "index": 1, + "statusCode": 429, + "message": "" + } + ] + } + }, + "500": { + "headers": {}, + "body": { + "itemsReceived": 1, + "itemsAccepted": 0, + "errors": [ + { + "index": 1, + "statusCode": 500, + "message": "" + } + ] + } + }, + "503": { + "headers": {}, + "body": { + "itemsReceived": 1, + "itemsAccepted": 0, + "errors": [ + { + "index": 1, + "statusCode": 503, + "message": "" + } + ] + } + } + } +} diff --git a/specification/applicationinsights/data-plane/Monitor.Exporters/preview/v2.1/swagger.json b/specification/applicationinsights/data-plane/Monitor.Exporters/preview/v2.1/swagger.json new file mode 100644 index 000000000000..e87c94887062 --- /dev/null +++ b/specification/applicationinsights/data-plane/Monitor.Exporters/preview/v2.1/swagger.json @@ -0,0 +1,1022 @@ +{ + "swagger": "2.0", + "info": { + "version": "v2.1", + "title": "ApplicationInsightsClient", + "description": "This document describes the protocol for client requests and responses to the data collection endpoint." + }, + "x-ms-parameterized-host": { + "hostTemplate": "{Host}/v2.1", + "useSchemePrefix": false, + "parameters": [ + { + "$ref": "#/parameters/Host" + } + ] + }, + "paths": { + "/track": { + "post": { + "summary": "Track telemetry events", + "description": "This operation sends a sequence of telemetry events that will be monitored by Azure Monitor.", + "operationId": "track", + "parameters": [ + { + "name": "body", + "in": "body", + "description": "The list of telemetry events to track.", + "required": true, + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/TelemetryEnvelope" + } + } + } + ], + "consumes": [ + "application/json", + "x-json-stream" + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "All of the telemetry items were accepted and processed.", + "schema": { + "$ref": "#/definitions/TrackResponse" + } + }, + "206": { + "description": "Partial success. Some of the telemetry items were accepted and processed.", + "schema": { + "$ref": "#/definitions/TrackResponse" + } + }, + "400": { + "description": "Bad Request", + "x-ms-error-response": true, + "schema": { + "$ref": "#/definitions/TrackResponse" + } + }, + "402": { + "description": "Payment Required", + "x-ms-error-response": true, + "schema": { + "$ref": "#/definitions/TrackResponse" + } + }, + "429": { + "description": "Too Many Requests", + "x-ms-error-response": true, + "schema": { + "$ref": "#/definitions/TrackResponse" + } + }, + "500": { + "description": "Internal Server Error", + "x-ms-error-response": true, + "schema": { + "$ref": "#/definitions/TrackResponse" + } + }, + "503": { + "description": "Service Unavailable", + "x-ms-error-response": true, + "schema": { + "$ref": "#/definitions/TrackResponse" + } + } + }, + "x-ms-examples": { + "Track examples": { + "$ref": "examples/track.json" + } + } + } + } + }, + "definitions": { + "AvailabilityData": { + "allOf": [ + { + "$ref": "#/definitions/Domain" + }, + { + "type": "object", + "description": "Instances of AvailabilityData represent the result of executing an availability test.", + "required": [ + "id", + "name", + "duration", + "success" + ], + "properties": { + "id": { + "type": "string", + "description": "Identifier of a test run. Use it to correlate steps of test run and telemetry generated by the service.", + "maxLength": 512 + }, + "name": { + "type": "string", + "description": "Name of the test that these availability results represent.", + "maxLength": 1024 + }, + "duration": { + "type": "string", + "description": "Duration in format: DD.HH:MM:SS.MMMMMM. Must be less than 1000 days." + }, + "success": { + "type": "boolean", + "x-nullable": false, + "description": "Success flag." + }, + "runLocation": { + "type": "string", + "description": "Name of the location where the test was run from.", + "maxLength": 1024 + }, + "message": { + "type": "string", + "description": "Diagnostic message for the result.", + "maxLength": 8192 + }, + "properties": { + "type": "object", + "description": "Collection of custom properties.", + "additionalProperties": { + "type": "string", + "maxLength": 8192 + } + }, + "measurements": { + "type": "object", + "description": "Collection of custom measurements.", + "additionalProperties": { + "type": "number", + "format": "double" + } + } + } + } + ] + }, + "Base": { + "x-ms-client-name": "MonitorBase", + "type": "object", + "description": "Data struct to contain only C section with custom fields.", + "properties": { + "baseType": { + "type": "string", + "description": "Name of item (B section) if any. If telemetry data is derived straight from this, this should be null." + }, + "baseData": { + "$ref": "#/definitions/Domain", + "description": "The data payload for the telemetry request" + } + } + }, + "DataPoint": { + "x-ms-client-name": "MetricDataPoint", + "type": "object", + "description": "Metric data single measurement.", + "required": [ + "name", + "value" + ], + "properties": { + "ns": { + "x-ms-client-name": "namespace", + "type": "string", + "description": "Namespace of the metric.", + "maxLength": 256 + }, + "name": { + "type": "string", + "description": "Name of the metric.", + "maxLength": 1024 + }, + "kind": { + "x-ms-client-name": "dataPointType", + "$ref": "#/definitions/DataPointType", + "description": "Metric type. Single measurement or the aggregated value." + }, + "value": { + "type": "number", + "description": "Single value for measurement. Sum of individual measurements for the aggregation.", + "format": "double" + }, + "count": { + "type": "number", + "format": "int32", + "description": "Metric weight of the aggregated metric. Should not be set for a measurement.", + "x-nullable": true + }, + "min": { + "type": "number", + "format": "double", + "description": "Minimum value of the aggregated metric. Should not be set for a measurement.", + "x-nullable": true + }, + "max": { + "type": "number", + "format": "double", + "description": "Maximum value of the aggregated metric. Should not be set for a measurement.", + "x-nullable": true + }, + "stdDev": { + "type": "number", + "format": "double", + "description": "Standard deviation of the aggregated metric. Should not be set for a measurement.", + "x-nullable": true + } + } + }, + "DataPointType": { + "type": "string", + "description": "Type of the metric data measurement.", + "enum": [ + "Measurement", + "Aggregation" + ] + }, + "Domain": { + "x-ms-client-name": "MonitorDomain", + "type": "object", + "description": "The abstract common base of all domains.", + "required": [ + "ver" + ], + "additionalProperties": true, + "properties": { + "ver": { + "x-ms-client-name": "version", + "type": "integer", + "format": "int32", + "description": "Schema version", + "default": 2 + } + } + }, + "EventData": { + "x-ms-client-name": "TelemetryEventData", + "allOf": [ + { + "$ref": "#/definitions/Domain" + }, + { + "type": "object", + "description": "Instances of Event represent structured event records that can be grouped and searched by their properties. Event data item also creates a metric of event count by name.", + "required": [ + "name" + ], + "properties": { + "name": { + "type": "string", + "description": "Event name. Keep it low cardinality to allow proper grouping and useful metrics.", + "maxLength": 512 + }, + "properties": { + "type": "object", + "description": "Collection of custom properties.", + "additionalProperties": { + "type": "string", + "maxLength": 8192 + } + }, + "measurements": { + "type": "object", + "description": "Collection of custom measurements.", + "additionalProperties": { + "type": "number", + "format": "double" + } + } + } + } + ] + }, + "ExceptionData": { + "x-ms-client-name": "TelemetryExceptionData", + "allOf": [ + { + "$ref": "#/definitions/Domain" + }, + { + "type": "object", + "description": "An instance of Exception represents a handled or unhandled exception that occurred during execution of the monitored application.", + "required": [ + "exceptions" + ], + "properties": { + "exceptions": { + "type": "array", + "description": "Exception chain - list of inner exceptions.", + "items": { + "$ref": "#/definitions/ExceptionDetails" + } + }, + "severityLevel": { + "x-nullable": true, + "description": "Severity level. Mostly used to indicate exception severity level when it is reported by logging library.", + "$ref": "#/definitions/SeverityLevel" + }, + "problemId": { + "type": "string", + "description": "Identifier of where the exception was thrown in code. Used for exceptions grouping. Typically a combination of exception type and a function from the call stack.", + "maxLength": 1024 + }, + "properties": { + "type": "object", + "description": "Collection of custom properties.", + "additionalProperties": { + "type": "string", + "maxLength": 8192 + } + }, + "measurements": { + "type": "object", + "description": "Collection of custom measurements.", + "additionalProperties": { + "type": "number", + "format": "double" + } + } + } + } + ] + }, + "ExceptionDetails": { + "x-ms-client-name": "TelemetryExceptionDetails", + "type": "object", + "description": "Exception details of the exception in a chain.", + "required": [ + "message" + ], + "properties": { + "id": { + "type": "number", + "format": "int32", + "description": "In case exception is nested (outer exception contains inner one), the id and outerId properties are used to represent the nesting." + }, + "outerId": { + "type": "number", + "format": "int32", + "description": "The value of outerId is a reference to an element in ExceptionDetails that represents the outer exception" + }, + "typeName": { + "type": "string", + "description": "Exception type name.", + "maxLength": 1024 + }, + "message": { + "type": "string", + "description": "Exception message.", + "maxLength": 32768 + }, + "hasFullStack": { + "type": "boolean", + "default": true, + "description": "Indicates if full exception stack is provided in the exception. The stack may be trimmed, such as in the case of a StackOverflow exception." + }, + "stack": { + "type": "string", + "description": "Text describing the stack. Either stack or parsedStack should have a value.", + "maxLength": 32768 + }, + "parsedStack": { + "type": "array", + "description": "List of stack frames. Either stack or parsedStack should have a value.", + "items": { + "$ref": "#/definitions/StackFrame" + } + } + } + }, + "MessageData": { + "allOf": [ + { + "$ref": "#/definitions/Domain" + }, + { + "type": "object", + "description": "Instances of Message represent printf-like trace statements that are text-searched. Log4Net, NLog and other text-based log file entries are translated into instances of this type. The message does not have measurements.", + "required": [ + "message" + ], + "properties": { + "message": { + "type": "string", + "description": "Trace message", + "maxLength": 32768 + }, + "severityLevel": { + "$ref": "#/definitions/SeverityLevel", + "description": "Trace severity level." + }, + "properties": { + "type": "object", + "description": "Collection of custom properties.", + "additionalProperties": { + "type": "string", + "maxLength": 8192 + } + }, + "measurements": { + "type": "object", + "description": "Collection of custom measurements.", + "additionalProperties": { + "type": "number", + "format": "double" + } + } + } + } + ] + }, + "MetricsData": { + "allOf": [ + { + "$ref": "#/definitions/Domain" + }, + { + "type": "object", + "description": "An instance of the Metric item is a list of measurements (single data points) and/or aggregations.", + "required": [ + "metrics" + ], + "properties": { + "metrics": { + "type": "array", + "description": "List of metrics. Only one metric in the list is currently supported by Application Insights storage. If multiple data points were sent only the first one will be used.", + "items": { + "$ref": "#/definitions/DataPoint" + } + }, + "properties": { + "type": "object", + "description": "Collection of custom properties.", + "additionalProperties": { + "type": "string", + "maxLength": 8192 + } + } + } + } + ] + }, + "PageViewData": { + "allOf": [ + { + "$ref": "#/definitions/Domain" + }, + { + "type": "object", + "description": "An instance of PageView represents a generic action on a page like a button click. It is also the base type for PageView.", + "required": [ + "id", + "name" + ], + "properties": { + "id": { + "type": "string", + "description": "Identifier of a page view instance. Used for correlation between page view and other telemetry items.", + "maxLength": 512 + }, + "name": { + "type": "string", + "description": "Event name. Keep it low cardinality to allow proper grouping and useful metrics.", + "maxLength": 1024 + }, + "url": { + "type": "string", + "description": "Request URL with all query string parameters", + "maxLength": 2048 + }, + "duration": { + "type": "string", + "description": "Request duration in format: DD.HH:MM:SS.MMMMMM. For a page view (PageViewData), this is the duration. For a page view with performance information (PageViewPerfData), this is the page load time. Must be less than 1000 days." + }, + "referredUri": { + "type": "string", + "description": "Fully qualified page URI or URL of the referring page; if unknown, leave blank", + "maxLength": 2048 + }, + "properties": { + "type": "object", + "description": "Collection of custom properties.", + "additionalProperties": { + "type": "string", + "maxLength": 8192 + } + }, + "measurements": { + "type": "object", + "description": "Collection of custom measurements.", + "additionalProperties": { + "type": "number", + "format": "double" + } + } + } + } + ] + }, + "PageViewPerfData": { + "allOf": [ + { + "$ref": "#/definitions/Domain" + }, + { + "type": "object", + "description": "An instance of PageViewPerf represents: a page view with no performance data, a page view with performance data, or just the performance data of an earlier page request.", + "required": [ + "id", + "name" + ], + "properties": { + "id": { + "type": "string", + "description": "Identifier of a page view instance. Used for correlation between page view and other telemetry items.", + "maxLength": 512 + }, + "name": { + "type": "string", + "description": "Event name. Keep it low cardinality to allow proper grouping and useful metrics.", + "maxLength": 1024 + }, + "url": { + "type": "string", + "description": "Request URL with all query string parameters", + "maxLength": 2048 + }, + "duration": { + "type": "string", + "description": "Request duration in format: DD.HH:MM:SS.MMMMMM. For a page view (PageViewData), this is the duration. For a page view with performance information (PageViewPerfData), this is the page load time. Must be less than 1000 days." + }, + "perfTotal": { + "type": "string", + "description": "Performance total in TimeSpan 'G' (general long) format: d:hh:mm:ss.fffffff" + }, + "networkConnect": { + "type": "string", + "description": "Network connection time in TimeSpan 'G' (general long) format: d:hh:mm:ss.fffffff" + }, + "sentRequest": { + "type": "string", + "description": "Sent request time in TimeSpan 'G' (general long) format: d:hh:mm:ss.fffffff" + }, + "receivedResponse": { + "type": "string", + "description": "Received response time in TimeSpan 'G' (general long) format: d:hh:mm:ss.fffffff" + }, + "domProcessing": { + "type": "string", + "description": "DOM processing time in TimeSpan 'G' (general long) format: d:hh:mm:ss.fffffff" + }, + "properties": { + "type": "object", + "description": "Collection of custom properties.", + "additionalProperties": { + "type": "string", + "maxLength": 8192 + } + }, + "measurements": { + "type": "object", + "description": "Collection of custom measurements.", + "additionalProperties": { + "type": "number", + "format": "double" + } + } + } + } + ] + }, + "RemoteDependencyData": { + "allOf": [ + { + "$ref": "#/definitions/Domain" + }, + { + "type": "object", + "description": "An instance of Remote Dependency represents an interaction of the monitored component with a remote component/service like SQL or an HTTP endpoint.", + "required": [ + "name", + "duration" + ], + "properties": { + "id": { + "type": "string", + "description": "Identifier of a dependency call instance. Used for correlation with the request telemetry item corresponding to this dependency call.", + "maxLength": 512 + }, + "name": { + "type": "string", + "description": "Name of the command initiated with this dependency call. Low cardinality value. Examples are stored procedure name and URL path template.", + "maxLength": 1024 + }, + "resultCode": { + "type": "string", + "description": "Result code of a dependency call. Examples are SQL error code and HTTP status code.", + "maxLength": 1024 + }, + "data": { + "type": "string", + "description": "Command initiated by this dependency call. Examples are SQL statement and HTTP URL with all query parameters.", + "maxLength": 8192 + }, + "type": { + "type": "string", + "description": "Dependency type name. Very low cardinality value for logical grouping of dependencies and interpretation of other fields like commandName and resultCode. Examples are SQL, Azure table, and HTTP.", + "maxLength": 1024 + }, + "target": { + "type": "string", + "description": "Target site of a dependency call. Examples are server name, host address.", + "maxLength": 1024 + }, + "duration": { + "type": "string", + "description": "Request duration in format: DD.HH:MM:SS.MMMMMM. Must be less than 1000 days." + }, + "success": { + "type": "boolean", + "description": "Indication of successful or unsuccessful call.", + "default": true + }, + "properties": { + "type": "object", + "description": "Collection of custom properties.", + "additionalProperties": { + "type": "string", + "maxLength": 8192 + } + }, + "measurements": { + "type": "object", + "description": "Collection of custom measurements.", + "additionalProperties": { + "type": "number", + "format": "double" + } + } + } + } + ] + }, + "RequestData": { + "allOf": [ + { + "$ref": "#/definitions/Domain" + }, + { + "type": "object", + "description": "An instance of Request represents completion of an external request to the application to do work and contains a summary of that request execution and the results.", + "required": [ + "id", + "duration", + "responseCode", + "success" + ], + "properties": { + "id": { + "type": "string", + "description": "Identifier of a request call instance. Used for correlation between request and other telemetry items.", + "maxLength": 512 + }, + "name": { + "type": "string", + "description": "Name of the request. Represents code path taken to process request. Low cardinality value to allow better grouping of requests. For HTTP requests it represents the HTTP method and URL path template like 'GET /values/{id}'.", + "maxLength": 1024 + }, + "duration": { + "type": "string", + "description": "Request duration in format: DD.HH:MM:SS.MMMMMM. Must be less than 1000 days." + }, + "success": { + "type": "boolean", + "description": "Indication of successful or unsuccessful call.", + "default": true + }, + "responseCode": { + "type": "string", + "description": "Result of a request execution. HTTP status code for HTTP requests.", + "maxLength": 1024 + }, + "source": { + "type": "string", + "description": "Source of the request. Examples are the instrumentation key of the caller or the ip address of the caller.", + "maxLength": 1024 + }, + "url": { + "type": "string", + "description": "Request URL with all query string parameters.", + "maxLength": 2048 + }, + "properties": { + "type": "object", + "description": "Collection of custom properties.", + "additionalProperties": { + "type": "string", + "maxLength": 8192 + } + }, + "measurements": { + "type": "object", + "description": "Collection of custom measurements.", + "additionalProperties": { + "type": "number", + "format": "double" + } + } + } + } + ] + }, + "SeverityLevel": { + "type": "string", + "description": "Defines the level of severity for the event.", + "enum": [ + "Verbose", + "Information", + "Warning", + "Error", + "Critical" + ] + }, + "StackFrame": { + "type": "object", + "description": "Stack frame information.", + "required": [ + "level", + "method" + ], + "properties": { + "level": { + "type": "number", + "format": "int32", + "description": "" + }, + "method": { + "type": "string", + "description": "Method name.", + "maxLength": 1024 + }, + "assembly": { + "type": "string", + "description": "Name of the assembly (dll, jar, etc.) containing this function.", + "maxLength": 1024 + }, + "fileName": { + "type": "string", + "description": "File name or URL of the method implementation.", + "maxLength": 1024 + }, + "line": { + "type": "number", + "format": "int32", + "description": "Line number of the code implementation." + } + } + }, + "TrackResponse": { + "description": "Response containing the status of each telemetry item.", + "type": "object", + "properties": { + "itemsReceived": { + "type": "number", + "format": "int32", + "description": "The number of items received." + }, + "itemsAccepted": { + "type": "number", + "format": "int32", + "description": "The number of items accepted." + }, + "errors": { + "type": "array", + "description": "An array of error detail objects.", + "items": { + "$ref": "#/definitions/ErrorDetails" + } + } + } + }, + "ErrorDetails": { + "x-ms-client-name": "TelemetryErrorDetails", + "description": "The error details", + "type": "object", + "properties": { + "index": { + "type": "number", + "format": "int32", + "description": "The index in the original payload of the item." + }, + "statusCode": { + "type": "number", + "format": "int32", + "description": "The item specific [HTTP Response status code](#Response Status Codes)." + }, + "message": { + "type": "string", + "description": "The error message." + } + } + }, + "TelemetryEnvelope": { + "x-ms-client-name": "TelemetryItem", + "description": "System variables for a telemetry item.", + "type": "object", + "required": [ + "name", + "time" + ], + "properties": { + "ver": { + "type": "number", + "x-ms-client-name": "version", + "format": "int32", + "default": 1, + "description": "Envelope version. For internal use only. By assigning this the default, it will not be serialized within the payload unless changed to a value other than #1." + }, + "name": { + "type": "string", + "description": "Type name of telemetry data item." + }, + "time": { + "type": "string", + "format": "date-time", + "description": "Event date time when telemetry item was created. This is the wall clock time on the client when the event was generated. There is no guarantee that the client's time is accurate. This field must be formatted in UTC ISO 8601 format, with a trailing 'Z' character, as described publicly on https://en.wikipedia.org/wiki/ISO_8601#UTC. Note: the number of decimal seconds digits provided are variable (and unspecified). Consumers should handle this, i.e. managed code consumers should not use format 'O' for parsing as it specifies a fixed length. Example: 2009-06-15T13:45:30.0000000Z." + }, + "sampleRate": { + "type": "number", + "format": "float", + "default": 100.0, + "description": "Sampling rate used in application. This telemetry item represents 100 / sampleRate actual telemetry items." + }, + "seq": { + "type": "string", + "x-ms-client-name": "sequence", + "maxLength": 64, + "description": "Sequence field used to track absolute order of uploaded events." + }, + "iKey": { + "type": "string", + "x-ms-client-name": "instrumentationKey", + "description": "The instrumentation key of the Application Insights resource." + }, + "tags": { + "type": "object", + "description": "Key/value collection of context properties. See ContextTagKeys for information on available properties.", + "additionalProperties": { + "type": "string" + } + }, + "data": { + "$ref": "#/definitions/Base", + "description": "Telemetry data item." + } + } + }, + "ContextTagKeys": { + "type": "string", + "description": "The context tag keys.", + "enum": [ + "ApplicationVersion", + "DeviceId", + "DeviceLocale", + "DeviceModel", + "DeviceOEMName", + "DeviceOSVersion", + "DeviceType", + "LocationIp", + "LocationCountry", + "LocationProvince", + "LocationCity", + "OperationId", + "OperationName", + "OperationParentId", + "OperationSyntheticSource", + "OperationCorrelationVector", + "SessionId", + "SessionIsFirst", + "UserAccountId", + "UserId", + "UserAuthUserId", + "CloudRole", + "CloudRoleVer", + "CloudRoleInstance", + "CloudLocation", + "InternalSdkVersion", + "InternalAgentVersion", + "InternalNodeName " + ], + "x-ms-enum": { + "name": "ContextTagKeys", + "modelAsString": true, + "values": [ + { + "value": "ai.application.ver" + }, + { + "value": "ai.device.id" + }, + { + "value": "ai.device.locale" + }, + { + "value": "ai.device.model" + }, + { + "value": "ai.device.oemName" + }, + { + "value": "ai.device.osVersion" + }, + { + "value": "ai.device.type" + }, + { + "value": "ai.location.ip" + }, + { + "value": "ai.location.country" + }, + { + "value": "ai.location.province" + }, + { + "value": "ai.location.city" + }, + { + "value": "ai.operation.id" + }, + { + "value": "ai.operation.name" + }, + { + "value": "ai.operation.parentId" + }, + { + "value": "ai.operation.syntheticSource" + }, + { + "value": "ai.operation.correlationVector" + }, + { + "value": "ai.session.id" + }, + { + "value": "ai.session.isFirst" + }, + { + "value": "ai.user.accountId" + }, + { + "value": "ai.user.id" + }, + { + "value": "ai.user.authUserId" + }, + { + "value": "ai.cloud.role" + }, + { + "value": "ai.cloud.roleVer" + }, + { + "value": "ai.cloud.roleInstance" + }, + { + "value": "ai.cloud.location" + }, + { + "value": "ai.internal.sdkVersion" + }, + { + "value": "ai.internal.agentVersion" + }, + { + "value": "ai.internal.nodeName" + } + ] + } + } + }, + "parameters": { + "Host": { + "name": "Host", + "description": "Breeze endpoint: https://dc.services.visualstudio.com", + "x-ms-parameter-location": "client", + "default": "https://dc.services.visualstudio.com", + "required": true, + "type": "string", + "in": "path", + "x-ms-skip-url-encoding": true + } + } +} diff --git a/specification/applicationinsights/data-plane/Monitor.Exporters/readme.md b/specification/applicationinsights/data-plane/Monitor.Exporters/readme.md index b1ae6ed86f47..fe680188a953 100644 --- a/specification/applicationinsights/data-plane/Monitor.Exporters/readme.md +++ b/specification/applicationinsights/data-plane/Monitor.Exporters/readme.md @@ -42,3 +42,17 @@ input-file: - preview/2020-09-15_Preview/swagger.json ``` +```yaml +openapi-type: data-plane +tag: v2.1 +``` + +### Tag: v2.1 + +These settings apply only when `--tag=v2.1` is specified on the command line. + +```yaml $(tag) == 'v2.1' +input-file: + - preview/v2.1/swagger.json +``` + diff --git a/specification/azsadmin/resource-manager/compute/Microsoft.Compute.Admin/preview/2015-12-01-preview/Compute.json b/specification/azsadmin/resource-manager/compute/Microsoft.Compute.Admin/preview/2015-12-01-preview/Compute.json index 3d95db7cc37c..c1427ac94da9 100644 --- a/specification/azsadmin/resource-manager/compute/Microsoft.Compute.Admin/preview/2015-12-01-preview/Compute.json +++ b/specification/azsadmin/resource-manager/compute/Microsoft.Compute.Admin/preview/2015-12-01-preview/Compute.json @@ -29,7 +29,7 @@ "operationId": "Operations_List", "parameters": [ { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -40,9 +40,9 @@ } }, "default": { - "description": "Default Response.", + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).", "schema": { - "$ref": "#/definitions/ErrorDetails" + "$ref": "Compute.json#/definitions/CrpErrorResponse" } } }, @@ -79,6 +79,32 @@ }, "x-ms-azure-resource": true }, + "CrpResource": { + "description": "Base resource object.", + "type": "object", + "properties": { + "id": { + "readOnly": true, + "description": "ID of the resource.", + "type": "string" + }, + "name": { + "readOnly": true, + "description": "Name of the resource.", + "type": "string" + }, + "type": { + "readOnly": true, + "description": "Type of Resource.", + "type": "string" + }, + "location": { + "description": "Location of the resource.", + "type": "string" + } + }, + "x-ms-azure-resource": true + }, "ProvisioningState": { "description": "The provisioning state of the resource.", "enum": [ @@ -94,6 +120,7 @@ }, "Operation": { "description": "Describes the supported REST operation.", + "type": "object", "properties": { "name": { "description": "The name of the operation being performed on this particular object. This name should match the name that appears in RBAC or the event service.", @@ -112,6 +139,7 @@ }, "Display": { "description": "Contains the localized display information for this particular operation or action.", + "type": "object", "properties": { "provider": { "description": "The localized, friendly version of the resource provider name. The provider name is expected to include the name of the publisher or company responsible. The provider name format should use title case and begin with \"Microsoft\" for first-party services. For example, the provider name may be\"Microsoft Monitoring Insights\" or \"Microsoft Compute.\"", @@ -133,6 +161,7 @@ }, "OperationList": { "description": "List of Operations", + "type": "object", "properties": { "value": { "description": "Array of operations", @@ -147,36 +176,53 @@ } } }, - "ErrorDetails": { - "description": "Error details.", - "type": "object", - "properties": { - "error": { - "description": "Object containing error details.", - "$ref": "#/definitions/ErrorDetailsInternal" - } - } - }, - "ErrorDetailsInternal": { - "description": "Error details.", + "ErrorDetail": { + "description": "The error detail.", "type": "object", "properties": { "code": { - "description": "The error code.", + "readOnly": true, "type": "string", - "readOnly": true + "description": "The error code." }, "message": { - "description": "The error message.", + "readOnly": true, "type": "string", - "readOnly": true + "description": "The error message." }, "target": { - "description": "The target of the particular error.", + "readOnly": true, "type": "string", - "readOnly": true + "description": "The error target." } } + }, + "CrpErrorResponse": { + "title": "Error response", + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).", + "type": "object", + "properties": { + "error": { + "description": "The error object.", + "$ref": "#/definitions/ErrorDetail" + } + } + }, + "ErrorAdditionalInfo": { + "type": "object", + "properties": { + "type": { + "readOnly": true, + "type": "string", + "description": "The additional info type." + }, + "info": { + "readOnly": true, + "type": "object", + "description": "The additional info." + } + }, + "description": "The resource management error additional info." } }, "parameters": { @@ -187,14 +233,6 @@ "required": true, "type": "string" }, - "ApiVersionParameter": { - "name": "api-version", - "in": "query", - "description": "Client API Version.", - "required": true, - "type": "string", - "default": "2015-12-01-preview" - }, "LocationParameter": { "description": "Location of the resource.", "name": "location", diff --git a/specification/azsadmin/resource-manager/compute/Microsoft.Compute.Admin/preview/2015-12-01-preview/PlatformImages.json b/specification/azsadmin/resource-manager/compute/Microsoft.Compute.Admin/preview/2015-12-01-preview/PlatformImages.json index 8b46a0f33670..0ea7cf5e15ae 100644 --- a/specification/azsadmin/resource-manager/compute/Microsoft.Compute.Admin/preview/2015-12-01-preview/PlatformImages.json +++ b/specification/azsadmin/resource-manager/compute/Microsoft.Compute.Admin/preview/2015-12-01-preview/PlatformImages.json @@ -36,7 +36,7 @@ "$ref": "Compute.json#/parameters/LocationParameter" }, { - "$ref": "Compute.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -47,9 +47,9 @@ } }, "default": { - "description": "Default Response.", + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).", "schema": { - "$ref": "#/definitions/ErrorDetails" + "$ref": "Compute.json#/definitions/CrpErrorResponse" } } } @@ -88,7 +88,7 @@ "$ref": "Compute.json#/parameters/VersionParameter" }, { - "$ref": "Compute.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -99,9 +99,9 @@ } }, "default": { - "description": "Default Response.", + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).", "schema": { - "$ref": "#/definitions/ErrorDetails" + "$ref": "Compute.json#/definitions/CrpErrorResponse" } } } @@ -138,7 +138,7 @@ "$ref": "Compute.json#/parameters/VersionParameter" }, { - "$ref": "Compute.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/NewPlatformImageParameter" @@ -164,9 +164,9 @@ } }, "default": { - "description": "Default Response.", + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).", "schema": { - "$ref": "#/definitions/ErrorDetails" + "$ref": "Compute.json#/definitions/CrpErrorResponse" } } }, @@ -204,14 +204,14 @@ "$ref": "Compute.json#/parameters/VersionParameter" }, { - "$ref": "Compute.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "responses": { "default": { - "description": "Default Response.", + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).", "schema": { - "$ref": "#/definitions/ErrorDetails" + "$ref": "Compute.json#/definitions/CrpErrorResponse" } }, "200": { @@ -234,7 +234,7 @@ }, "allOf": [ { - "$ref": "Compute.json#/definitions/Resource" + "$ref": "Compute.json#/definitions/CrpResource" } ] }, @@ -331,37 +331,6 @@ "$ref": "#/definitions/PlatformImageProperties" } } - }, - "ErrorDetails": { - "description": "Error details.", - "type": "object", - "properties": { - "error": { - "description": "Object containing error details.", - "$ref": "#/definitions/ErrorDetailsInternal" - } - } - }, - "ErrorDetailsInternal": { - "description": "Error details.", - "type": "object", - "properties": { - "code": { - "description": "The error code.", - "type": "string", - "readOnly": true - }, - "message": { - "description": "The error message.", - "type": "string", - "readOnly": true - }, - "target": { - "description": "The target of the particular error.", - "type": "string", - "readOnly": true - } - } } }, "parameters": { diff --git a/specification/azsadmin/resource-manager/compute/Microsoft.Compute.Admin/preview/2015-12-01-preview/Quotas.json b/specification/azsadmin/resource-manager/compute/Microsoft.Compute.Admin/preview/2015-12-01-preview/Quotas.json index 046fa9229b43..614d08736800 100644 --- a/specification/azsadmin/resource-manager/compute/Microsoft.Compute.Admin/preview/2015-12-01-preview/Quotas.json +++ b/specification/azsadmin/resource-manager/compute/Microsoft.Compute.Admin/preview/2015-12-01-preview/Quotas.json @@ -39,7 +39,7 @@ "$ref": "#/parameters/QuotaParameter" }, { - "$ref": "Compute.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -80,7 +80,7 @@ "$ref": "#/parameters/QuotaParameter" }, { - "$ref": "Compute.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/NewQuotaParameter" @@ -124,7 +124,7 @@ "$ref": "#/parameters/QuotaParameter" }, { - "$ref": "Compute.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -161,7 +161,7 @@ "$ref": "Compute.json#/parameters/LocationParameter" }, { - "$ref": "Compute.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -191,7 +191,7 @@ }, "allOf": [ { - "$ref": "Compute.json#/definitions/Resource" + "$ref": "Compute.json#/definitions/CrpResource" } ] }, diff --git a/specification/azsadmin/resource-manager/compute/Microsoft.Compute.Admin/preview/2015-12-01-preview/VMExtensions.json b/specification/azsadmin/resource-manager/compute/Microsoft.Compute.Admin/preview/2015-12-01-preview/VMExtensions.json index 7a8c478f0d70..f7972ddfce81 100644 --- a/specification/azsadmin/resource-manager/compute/Microsoft.Compute.Admin/preview/2015-12-01-preview/VMExtensions.json +++ b/specification/azsadmin/resource-manager/compute/Microsoft.Compute.Admin/preview/2015-12-01-preview/VMExtensions.json @@ -45,7 +45,7 @@ "$ref": "Compute.json#/parameters/VersionParameter" }, { - "$ref": "Compute.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -56,9 +56,9 @@ } }, "default": { - "description": "Default Response.", + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).", "schema": { - "$ref": "#/definitions/ErrorDetails" + "$ref": "Compute.json#/definitions/CrpErrorResponse" } } } @@ -98,7 +98,7 @@ "$ref": "Compute.json#/parameters/VersionParameter" }, { - "$ref": "Compute.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/VMExtensionParameter" @@ -118,9 +118,9 @@ } }, "default": { - "description": "Default Response.", + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).", "schema": { - "$ref": "#/definitions/ErrorDetails" + "$ref": "Compute.json#/definitions/CrpErrorResponse" } } } @@ -160,7 +160,7 @@ "$ref": "Compute.json#/parameters/VersionParameter" }, { - "$ref": "Compute.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -168,9 +168,9 @@ "description": "OK" }, "default": { - "description": "Default Response.", + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).", "schema": { - "$ref": "#/definitions/ErrorDetails" + "$ref": "Compute.json#/definitions/CrpErrorResponse" } } } @@ -203,7 +203,7 @@ "$ref": "Compute.json#/parameters/LocationParameter" }, { - "$ref": "Compute.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -214,9 +214,9 @@ } }, "default": { - "description": "Default Response.", + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).", "schema": { - "$ref": "#/definitions/ErrorDetails" + "$ref": "Compute.json#/definitions/CrpErrorResponse" } } } @@ -236,7 +236,7 @@ }, "allOf": [ { - "$ref": "Compute.json#/definitions/Resource" + "$ref": "Compute.json#/definitions/CrpResource" } ] }, @@ -305,37 +305,6 @@ "$ref": "#/definitions/VMExtensionProperties" } } - }, - "ErrorDetails": { - "description": "Error details.", - "type": "object", - "properties": { - "error": { - "description": "Object containing error details.", - "$ref": "#/definitions/ErrorDetailsInternal" - } - } - }, - "ErrorDetailsInternal": { - "description": "Error details.", - "type": "object", - "properties": { - "code": { - "description": "The error code.", - "type": "string", - "readOnly": true - }, - "message": { - "description": "The error message.", - "type": "string", - "readOnly": true - }, - "target": { - "description": "The target of the particular error.", - "type": "string", - "readOnly": true - } - } } }, "parameters": { diff --git a/specification/azsadmin/resource-manager/compute/Microsoft.Compute.Admin/preview/2018-02-09/Quotas.json b/specification/azsadmin/resource-manager/compute/Microsoft.Compute.Admin/preview/2018-02-09/Quotas.json index e8517f1d54e0..599fe25344e2 100644 --- a/specification/azsadmin/resource-manager/compute/Microsoft.Compute.Admin/preview/2018-02-09/Quotas.json +++ b/specification/azsadmin/resource-manager/compute/Microsoft.Compute.Admin/preview/2018-02-09/Quotas.json @@ -39,7 +39,7 @@ "$ref": "Quotas.json#/parameters/QuotaParameter" }, { - "$ref": "Quotas.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -80,7 +80,7 @@ "$ref": "Quotas.json#/parameters/QuotaParameter" }, { - "$ref": "Quotas.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" }, { "$ref": "Quotas.json#/parameters/NewQuotaParameter" @@ -124,7 +124,7 @@ "$ref": "Quotas.json#/parameters/QuotaParameter" }, { - "$ref": "Quotas.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -161,7 +161,7 @@ "$ref": "../2015-12-01-preview/Compute.json#/parameters/LocationParameter" }, { - "$ref": "Quotas.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -256,13 +256,6 @@ } }, "parameters": { - "ApiVersionParameter": { - "name": "api-version", - "in": "query", - "description": "Client API Version.", - "required": true, - "type": "string" - }, "QuotaParameter": { "description": "Name of the quota.", "name": "quotaName", diff --git a/specification/azsadmin/resource-manager/compute/Microsoft.Compute.Admin/preview/2018-07-30-preview/DiskMigrationJobs.json b/specification/azsadmin/resource-manager/compute/Microsoft.Compute.Admin/preview/2018-07-30-preview/DiskMigrationJobs.json index e4635d68b2e5..0a1302baa3f9 100644 --- a/specification/azsadmin/resource-manager/compute/Microsoft.Compute.Admin/preview/2018-07-30-preview/DiskMigrationJobs.json +++ b/specification/azsadmin/resource-manager/compute/Microsoft.Compute.Admin/preview/2018-07-30-preview/DiskMigrationJobs.json @@ -39,7 +39,7 @@ "$ref": "DiskMigrationJobs.json#/parameters/MigrationJobStatusParameter" }, { - "$ref": "Disks.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -50,9 +50,9 @@ } }, "default": { - "description": "Default Response.", + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).", "schema": { - "$ref": "#/definitions/ErrorDetails" + "$ref": "../2015-12-01-preview/Compute.json#/definitions/CrpErrorResponse" } } }, @@ -84,7 +84,7 @@ "$ref": "DiskMigrationJobs.json#/parameters/MigrationIdParameter" }, { - "$ref": "Disks.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -95,9 +95,9 @@ } }, "default": { - "description": "Default Response.", + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).", "schema": { - "$ref": "#/definitions/ErrorDetails" + "$ref": "../2015-12-01-preview/Compute.json#/definitions/CrpErrorResponse" } } } @@ -136,7 +136,7 @@ "$ref": "DiskMigrationJobs.json#/parameters/DiskListParameter" }, { - "$ref": "Disks.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -147,9 +147,9 @@ } }, "default": { - "description": "Default Response.", + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).", "schema": { - "$ref": "#/definitions/ErrorDetails" + "$ref": "../2015-12-01-preview/Compute.json#/definitions/CrpErrorResponse" } } } @@ -178,7 +178,7 @@ "$ref": "DiskMigrationJobs.json#/parameters/MigrationIdParameter" }, { - "$ref": "Disks.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -189,9 +189,9 @@ } }, "default": { - "description": "Default Response.", + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).", "schema": { - "$ref": "#/definitions/ErrorDetails" + "$ref": "../2015-12-01-preview/Compute.json#/definitions/CrpErrorResponse" } } } @@ -385,37 +385,6 @@ "items": { "$ref": "Disks.json#/definitions/Disk" } - }, - "ErrorDetails": { - "description": "Error details.", - "type": "object", - "properties": { - "error": { - "description": "Object containing error details.", - "$ref": "#/definitions/ErrorDetailsInternal" - } - } - }, - "ErrorDetailsInternal": { - "description": "Error details.", - "type": "object", - "properties": { - "code": { - "description": "The error code.", - "type": "string", - "readOnly": true - }, - "message": { - "description": "The error message.", - "type": "string", - "readOnly": true - }, - "target": { - "description": "The target of the particular error.", - "type": "string", - "readOnly": true - } - } } }, "parameters": { diff --git a/specification/azsadmin/resource-manager/compute/Microsoft.Compute.Admin/preview/2018-07-30-preview/Disks.json b/specification/azsadmin/resource-manager/compute/Microsoft.Compute.Admin/preview/2018-07-30-preview/Disks.json index cd4dd27b232a..3dd553e131ba 100644 --- a/specification/azsadmin/resource-manager/compute/Microsoft.Compute.Admin/preview/2018-07-30-preview/Disks.json +++ b/specification/azsadmin/resource-manager/compute/Microsoft.Compute.Admin/preview/2018-07-30-preview/Disks.json @@ -57,7 +57,7 @@ "$ref": "Disks.json#/parameters/DiskStartParameter" }, { - "$ref": "Disks.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -68,9 +68,9 @@ } }, "default": { - "description": "Default Response.", + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).", "schema": { - "$ref": "#/definitions/ErrorDetails" + "$ref": "../2015-12-01-preview/Compute.json#/definitions/CrpErrorResponse" } } }, @@ -102,7 +102,7 @@ "$ref": "Disks.json#/parameters/DiskIdParameter" }, { - "$ref": "Disks.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -113,9 +113,9 @@ } }, "default": { - "description": "Default Response.", + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).", "schema": { - "$ref": "#/definitions/ErrorDetails" + "$ref": "../2015-12-01-preview/Compute.json#/definitions/CrpErrorResponse" } } } @@ -257,48 +257,9 @@ "name": "AccountType", "modelAsString": true } - }, - "ErrorDetails": { - "description": "Error details.", - "type": "object", - "properties": { - "error": { - "description": "Object containing error details.", - "$ref": "#/definitions/ErrorDetailsInternal" - } - } - }, - "ErrorDetailsInternal": { - "description": "Error details.", - "type": "object", - "properties": { - "code": { - "description": "The error code.", - "type": "string", - "readOnly": true - }, - "message": { - "description": "The error message.", - "type": "string", - "readOnly": true - }, - "target": { - "description": "The target of the particular error.", - "type": "string", - "readOnly": true - } - } } }, "parameters": { - "ApiVersionParameter": { - "name": "api-version", - "in": "query", - "description": "Client API Version.", - "required": true, - "type": "string", - "default": "2018-07-30-preview" - }, "UserSubscriptionIdParameter": { "description": "User Subscription Id which the resource belongs to.", "name": "userSubscriptionId", diff --git a/specification/azsadmin/resource-manager/compute/Microsoft.Compute.Admin/stable/2020-11-01/Features.json b/specification/azsadmin/resource-manager/compute/Microsoft.Compute.Admin/stable/2020-11-01/Features.json index 08e49c717a68..298398535e20 100644 --- a/specification/azsadmin/resource-manager/compute/Microsoft.Compute.Admin/stable/2020-11-01/Features.json +++ b/specification/azsadmin/resource-manager/compute/Microsoft.Compute.Admin/stable/2020-11-01/Features.json @@ -30,16 +30,16 @@ ], "parameters": [ { - "$ref": "Features.json#/parameters/SubscriptionIdParameter" + "$ref": "../../preview/2015-12-01-preview/Compute.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "Features.json#/parameters/LocationParameter" + "$ref": "../../preview/2015-12-01-preview/Compute.json#/parameters/LocationParameter" }, { "$ref": "Features.json#/parameters/FeatureParameter" }, { - "$ref": "Features.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -50,9 +50,9 @@ } }, "default": { - "description": "Default error response.", + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).", "schema": { - "$ref": "#/definitions/ErrorDetails" + "$ref": "../../preview/2015-12-01-preview/Compute.json#/definitions/CrpErrorResponse" } } } @@ -79,13 +79,13 @@ ], "parameters": [ { - "$ref": "Features.json#/parameters/SubscriptionIdParameter" + "$ref": "../../preview/2015-12-01-preview/Compute.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "Features.json#/parameters/LocationParameter" + "$ref": "../../preview/2015-12-01-preview/Compute.json#/parameters/LocationParameter" }, { - "$ref": "Features.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -96,9 +96,9 @@ } }, "default": { - "description": "Default error response.", + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).", "schema": { - "$ref": "#/definitions/ErrorDetails" + "$ref": "../../preview/2015-12-01-preview/Compute.json#/definitions/CrpErrorResponse" } } }, @@ -128,16 +128,16 @@ ], "parameters": [ { - "$ref": "Features.json#/parameters/SubscriptionIdParameter" + "$ref": "../../preview/2015-12-01-preview/Compute.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "Features.json#/parameters/LocationParameter" + "$ref": "../../preview/2015-12-01-preview/Compute.json#/parameters/LocationParameter" }, { "$ref": "Features.json#/parameters/FeatureParameter" }, { - "$ref": "Features.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" }, { "$ref": "Features.json#/parameters/GlobalFeatureSettingsParameter" @@ -148,9 +148,9 @@ "description": "OK" }, "default": { - "description": "Default error response.", + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).", "schema": { - "$ref": "#/definitions/ErrorDetails" + "$ref": "../../preview/2015-12-01-preview/Compute.json#/definitions/CrpErrorResponse" } } } @@ -177,16 +177,16 @@ ], "parameters": [ { - "$ref": "Features.json#/parameters/SubscriptionIdParameter" + "$ref": "../../preview/2015-12-01-preview/Compute.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "Features.json#/parameters/LocationParameter" + "$ref": "../../preview/2015-12-01-preview/Compute.json#/parameters/LocationParameter" }, { "$ref": "Features.json#/parameters/FeatureParameter" }, { - "$ref": "Features.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" }, { "$ref": "Features.json#/parameters/TenantSubscriptionFeatureSettingsParameter" @@ -197,9 +197,9 @@ "description": "OK" }, "default": { - "description": "Default error response.", + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).", "schema": { - "$ref": "#/definitions/ErrorDetails" + "$ref": "../../preview/2015-12-01-preview/Compute.json#/definitions/CrpErrorResponse" } } } @@ -226,16 +226,16 @@ ], "parameters": [ { - "$ref": "Features.json#/parameters/SubscriptionIdParameter" + "$ref": "../../preview/2015-12-01-preview/Compute.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "Features.json#/parameters/LocationParameter" + "$ref": "../../preview/2015-12-01-preview/Compute.json#/parameters/LocationParameter" }, { "$ref": "Features.json#/parameters/FeatureParameter" }, { - "$ref": "Features.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" }, { "$ref": "Features.json#/parameters/TenantSubscriptionFeatureSettingsParameter" @@ -246,9 +246,9 @@ "description": "OK" }, "default": { - "description": "Default error response.", + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).", "schema": { - "$ref": "#/definitions/ErrorDetails" + "$ref": "../../preview/2015-12-01-preview/Compute.json#/definitions/CrpErrorResponse" } } } @@ -268,7 +268,7 @@ }, "allOf": [ { - "$ref": "#/definitions/Resource" + "$ref": "../../preview/2015-12-01-preview/Compute.json#/definitions/CrpResource" } ] }, @@ -341,88 +341,9 @@ "type": "string" } } - }, - "ErrorDetails": { - "description": "Error details.", - "type": "object", - "properties": { - "error": { - "description": "Object containing error details.", - "$ref": "#/definitions/ErrorDetailsInternal" - } - } - }, - "ErrorDetailsInternal": { - "description": "Error details.", - "type": "object", - "properties": { - "code": { - "description": "The error code.", - "type": "string", - "readOnly": true - }, - "message": { - "description": "The error message.", - "type": "string", - "readOnly": true - }, - "target": { - "description": "The target of the particular error.", - "type": "string", - "readOnly": true - } - } - }, - "Resource": { - "description": "Base resource object.", - "type": "object", - "properties": { - "id": { - "readOnly": true, - "description": "ID of the resource.", - "type": "string" - }, - "name": { - "readOnly": true, - "description": "Name of the resource.", - "type": "string" - }, - "type": { - "readOnly": true, - "description": "Type of Resource.", - "type": "string" - }, - "location": { - "description": "Location of the resource.", - "type": "string" - } - }, - "x-ms-azure-resource": true } }, "parameters": { - "SubscriptionIdParameter": { - "name": "subscriptionId", - "in": "path", - "description": "Subscription credentials that uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.", - "required": true, - "type": "string" - }, - "ApiVersionParameter": { - "name": "api-version", - "in": "query", - "description": "Client API Version.", - "required": true, - "type": "string" - }, - "LocationParameter": { - "description": "Location of the resource.", - "name": "location", - "in": "path", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, "FeatureParameter": { "description": "Name of the feature.", "name": "featureName", diff --git a/specification/azsadmin/resource-manager/compute/Microsoft.Compute.Admin/stable/2021-01-01/Quotas.json b/specification/azsadmin/resource-manager/compute/Microsoft.Compute.Admin/stable/2021-01-01/Quotas.json index a4b47d7f5cca..b776b710b058 100644 --- a/specification/azsadmin/resource-manager/compute/Microsoft.Compute.Admin/stable/2021-01-01/Quotas.json +++ b/specification/azsadmin/resource-manager/compute/Microsoft.Compute.Admin/stable/2021-01-01/Quotas.json @@ -30,16 +30,16 @@ ], "parameters": [ { - "$ref": "Quotas.json#/parameters/SubscriptionIdParameter" + "$ref": "../../preview/2015-12-01-preview/Compute.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "Quotas.json#/parameters/LocationParameter" + "$ref": "../../preview/2015-12-01-preview/Compute.json#/parameters/LocationParameter" }, { "$ref": "Quotas.json#/parameters/QuotaParameter" }, { - "$ref": "Quotas.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -50,9 +50,9 @@ } }, "default": { - "description": "Default Response.", + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).", "schema": { - "$ref": "#/definitions/ErrorDetails" + "$ref": "../../preview/2015-12-01-preview/Compute.json#/definitions/CrpErrorResponse" } } } @@ -77,16 +77,16 @@ ], "parameters": [ { - "$ref": "Quotas.json#/parameters/SubscriptionIdParameter" + "$ref": "../../preview/2015-12-01-preview/Compute.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "Quotas.json#/parameters/LocationParameter" + "$ref": "../../preview/2015-12-01-preview/Compute.json#/parameters/LocationParameter" }, { "$ref": "Quotas.json#/parameters/QuotaParameter" }, { - "$ref": "Quotas.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" }, { "$ref": "Quotas.json#/parameters/NewQuotaParameter" @@ -100,9 +100,9 @@ } }, "default": { - "description": "Default Response.", + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).", "schema": { - "$ref": "#/definitions/ErrorDetails" + "$ref": "../../preview/2015-12-01-preview/Compute.json#/definitions/CrpErrorResponse" } } } @@ -127,16 +127,16 @@ ], "parameters": [ { - "$ref": "Quotas.json#/parameters/SubscriptionIdParameter" + "$ref": "../../preview/2015-12-01-preview/Compute.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "Quotas.json#/parameters/LocationParameter" + "$ref": "../../preview/2015-12-01-preview/Compute.json#/parameters/LocationParameter" }, { "$ref": "Quotas.json#/parameters/QuotaParameter" }, { - "$ref": "Quotas.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -144,9 +144,9 @@ "description": "OK" }, "default": { - "description": "Default Response.", + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).", "schema": { - "$ref": "#/definitions/ErrorDetails" + "$ref": "../../preview/2015-12-01-preview/Compute.json#/definitions/CrpErrorResponse" } } } @@ -173,13 +173,13 @@ ], "parameters": [ { - "$ref": "Quotas.json#/parameters/SubscriptionIdParameter" + "$ref": "../../preview/2015-12-01-preview/Compute.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "Quotas.json#/parameters/LocationParameter" + "$ref": "../../preview/2015-12-01-preview/Compute.json#/parameters/LocationParameter" }, { - "$ref": "Quotas.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -190,9 +190,9 @@ } }, "default": { - "description": "Default Response.", + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).", "schema": { - "$ref": "#/definitions/ErrorDetails" + "$ref": "../../preview/2015-12-01-preview/Compute.json#/definitions/CrpErrorResponse" } } }, @@ -215,7 +215,7 @@ }, "allOf": [ { - "$ref": "#/definitions/Resource" + "$ref": "../../preview/2015-12-01-preview/Compute.json#/definitions/CrpResource" } ] }, @@ -289,88 +289,9 @@ } } } - }, - "Resource": { - "description": "Base resource object.", - "type": "object", - "properties": { - "id": { - "readOnly": true, - "description": "ID of the resource.", - "type": "string" - }, - "name": { - "readOnly": true, - "description": "Name of the resource.", - "type": "string" - }, - "type": { - "readOnly": true, - "description": "Type of Resource.", - "type": "string" - }, - "location": { - "description": "Location of the resource.", - "type": "string" - } - }, - "x-ms-azure-resource": true - }, - "ErrorDetails": { - "description": "Error details.", - "type": "object", - "properties": { - "error": { - "description": "Object containing error details.", - "$ref": "#/definitions/ErrorDetailsInternal" - } - } - }, - "ErrorDetailsInternal": { - "description": "Error details.", - "type": "object", - "properties": { - "code": { - "description": "The error code.", - "type": "string", - "readOnly": true - }, - "message": { - "description": "The error message.", - "type": "string", - "readOnly": true - }, - "target": { - "description": "The target of the particular error.", - "type": "string", - "readOnly": true - } - } } }, "parameters": { - "SubscriptionIdParameter": { - "name": "subscriptionId", - "in": "path", - "description": "Subscription credentials that uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.", - "required": true, - "type": "string" - }, - "ApiVersionParameter": { - "name": "api-version", - "in": "query", - "description": "Client API Version.", - "required": true, - "type": "string" - }, - "LocationParameter": { - "description": "Location of the resource.", - "name": "location", - "in": "path", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, "QuotaParameter": { "description": "Name of the quota.", "name": "quotaName", diff --git a/specification/azsadmin/resource-manager/compute/Microsoft.Compute.Admin/stable/2021-03-30/ScaleUnits.json b/specification/azsadmin/resource-manager/compute/Microsoft.Compute.Admin/stable/2021-03-30/ScaleUnits.json index 4b58376db718..5fae6684baaf 100644 --- a/specification/azsadmin/resource-manager/compute/Microsoft.Compute.Admin/stable/2021-03-30/ScaleUnits.json +++ b/specification/azsadmin/resource-manager/compute/Microsoft.Compute.Admin/stable/2021-03-30/ScaleUnits.json @@ -9,7 +9,7 @@ "https" ], "paths": { - "/providers/Microsoft.Compute.Admin/locations/{location}/computeScaleUnits/{scaleUnitName}": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute.Admin/locations/{location}/computeScaleUnits/{scaleUnitName}": { "get": { "x-ms-examples": { "Get an existing scale set.": { @@ -30,13 +30,16 @@ ], "parameters": [ { - "$ref": "ScaleUnits.json#/parameters/LocationParameter" + "$ref": "../../preview/2015-12-01-preview/Compute.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../preview/2015-12-01-preview/Compute.json#/parameters/LocationParameter" }, { "$ref": "ScaleUnits.json#/parameters/ScaleUnitParameter" }, { - "$ref": "ScaleUnits.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -47,9 +50,9 @@ } }, "default": { - "description": "Default Response.", + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).", "schema": { - "$ref": "#/definitions/ErrorDetails" + "$ref": "../../preview/2015-12-01-preview/Compute.json#/definitions/CrpErrorResponse" } } } @@ -69,7 +72,7 @@ }, "allOf": [ { - "$ref": "#/definitions/Resource" + "$ref": "../../preview/2015-12-01-preview/Compute.json#/definitions/Resource" } ] }, @@ -184,81 +187,9 @@ } } } - }, - "Resource": { - "description": "Base resource object.", - "type": "object", - "properties": { - "id": { - "readOnly": true, - "description": "ID of the resource.", - "type": "string" - }, - "name": { - "readOnly": true, - "description": "Name of the resource.", - "type": "string" - }, - "type": { - "readOnly": true, - "description": "Type of Resource.", - "type": "string" - }, - "location": { - "description": "Location of the resource.", - "type": "string" - } - }, - "x-ms-azure-resource": true - }, - "ErrorDetails": { - "description": "Error details.", - "type": "object", - "properties": { - "error": { - "description": "Object containing error details.", - "$ref": "#/definitions/ErrorDetailsInternal" - } - } - }, - "ErrorDetailsInternal": { - "description": "Error details.", - "type": "object", - "properties": { - "code": { - "description": "The error code.", - "type": "string", - "readOnly": true - }, - "message": { - "description": "The error message.", - "type": "string", - "readOnly": true - }, - "target": { - "description": "The target of the particular error.", - "type": "string", - "readOnly": true - } - } } }, "parameters": { - "ApiVersionParameter": { - "name": "api-version", - "in": "query", - "description": "Client API Version.", - "required": true, - "type": "string" - }, - "LocationParameter": { - "description": "Location of the resource.", - "name": "location", - "in": "path", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, "ScaleUnitParameter": { "description": "Name of the scale unit.", "name": "scaleUnitName", diff --git a/specification/azsadmin/resource-manager/compute/Microsoft.Compute.Admin/stable/2021-03-30/examples/ScaleUnits/Get.json b/specification/azsadmin/resource-manager/compute/Microsoft.Compute.Admin/stable/2021-03-30/examples/ScaleUnits/Get.json index acc2a8970626..0e369316cb79 100644 --- a/specification/azsadmin/resource-manager/compute/Microsoft.Compute.Admin/stable/2021-03-30/examples/ScaleUnits/Get.json +++ b/specification/azsadmin/resource-manager/compute/Microsoft.Compute.Admin/stable/2021-03-30/examples/ScaleUnits/Get.json @@ -1,13 +1,14 @@ { "parameters": { "location": "local", + "subscriptionId": "FAC2EE4D-C642-4411-A8BE-68379E72FC96", "scaleUnitName": "s-cluster", "api-version": "2021-03-30" }, "responses": { "200": { "body": { - "id": "/providers/Microsoft.Compute.Admin/locations/local/computeScaleUnits/s-cluster", + "id": "/subscriptions/FAC2EE4D-C642-4411-A8BE-68379E72FC96/providers/Microsoft.Compute.Admin/locations/local/computeScaleUnits/s-cluster", "type": "Microsoft.Compute.Admin/locations/computeScaleUnits", "location": "local", "properties": { diff --git a/specification/azsadmin/resource-manager/compute/Microsoft.Compute.Admin/stable/2021-04-01/DiskMigrationJobs.json b/specification/azsadmin/resource-manager/compute/Microsoft.Compute.Admin/stable/2021-04-01/DiskMigrationJobs.json index ebf93493cbd8..fe2f8f6bd4bb 100644 --- a/specification/azsadmin/resource-manager/compute/Microsoft.Compute.Admin/stable/2021-04-01/DiskMigrationJobs.json +++ b/specification/azsadmin/resource-manager/compute/Microsoft.Compute.Admin/stable/2021-04-01/DiskMigrationJobs.json @@ -30,16 +30,16 @@ "description": "Returns a list of disk migration jobs.", "parameters": [ { - "$ref": "Disks.json#/parameters/SubscriptionIdParameter" + "$ref": "../../preview/2015-12-01-preview/Compute.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "Disks.json#/parameters/LocationParameter" + "$ref": "../../preview/2015-12-01-preview/Compute.json#/parameters/LocationParameter" }, { "$ref": "DiskMigrationJobs.json#/parameters/MigrationJobStatusParameter" }, { - "$ref": "Disks.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -75,16 +75,16 @@ "description": "Returns the requested disk migration job.", "parameters": [ { - "$ref": "Disks.json#/parameters/SubscriptionIdParameter" + "$ref": "../../preview/2015-12-01-preview/Compute.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "Disks.json#/parameters/LocationParameter" + "$ref": "../../preview/2015-12-01-preview/Compute.json#/parameters/LocationParameter" }, { "$ref": "DiskMigrationJobs.json#/parameters/MigrationIdParameter" }, { - "$ref": "Disks.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -115,10 +115,10 @@ "description": "Create a disk migration job.", "parameters": [ { - "$ref": "Disks.json#/parameters/SubscriptionIdParameter" + "$ref": "../../preview/2015-12-01-preview/Compute.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "Disks.json#/parameters/LocationParameter" + "$ref": "../../preview/2015-12-01-preview/Compute.json#/parameters/LocationParameter" }, { "$ref": "DiskMigrationJobs.json#/parameters/MigrationIdParameter" @@ -136,7 +136,7 @@ "$ref": "DiskMigrationJobs.json#/parameters/DiskListParameter" }, { - "$ref": "Disks.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -169,16 +169,16 @@ "description": "Cancel a disk migration job.", "parameters": [ { - "$ref": "Disks.json#/parameters/SubscriptionIdParameter" + "$ref": "../../preview/2015-12-01-preview/Compute.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "Disks.json#/parameters/LocationParameter" + "$ref": "../../preview/2015-12-01-preview/Compute.json#/parameters/LocationParameter" }, { "$ref": "DiskMigrationJobs.json#/parameters/MigrationIdParameter" }, { - "$ref": "Disks.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "responses": { diff --git a/specification/azsadmin/resource-manager/compute/Microsoft.Compute.Admin/stable/2021-04-01/Disks.json b/specification/azsadmin/resource-manager/compute/Microsoft.Compute.Admin/stable/2021-04-01/Disks.json index 575505b8c72d..aba9c372ab09 100644 --- a/specification/azsadmin/resource-manager/compute/Microsoft.Compute.Admin/stable/2021-04-01/Disks.json +++ b/specification/azsadmin/resource-manager/compute/Microsoft.Compute.Admin/stable/2021-04-01/Disks.json @@ -30,10 +30,10 @@ "description": "Returns a list of disks.", "parameters": [ { - "$ref": "Disks.json#/parameters/SubscriptionIdParameter" + "$ref": "../../preview/2015-12-01-preview/Compute.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "Disks.json#/parameters/LocationParameter" + "$ref": "../../preview/2015-12-01-preview/Compute.json#/parameters/LocationParameter" }, { "$ref": "Disks.json#/parameters/UserSubscriptionIdParameter" @@ -57,7 +57,7 @@ "$ref": "Disks.json#/parameters/DiskStartParameter" }, { - "$ref": "Disks.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -93,10 +93,10 @@ "description": "Returns the disk.", "parameters": [ { - "$ref": "Disks.json#/parameters/SubscriptionIdParameter" + "$ref": "../../preview/2015-12-01-preview/Compute.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "Disks.json#/parameters/LocationParameter" + "$ref": "../../preview/2015-12-01-preview/Compute.json#/parameters/LocationParameter" }, { "$ref": "Disks.json#/parameters/DiskIdParameter" @@ -105,7 +105,7 @@ "$ref": "Disks.json#/parameters/DiskSizeDetailParameter" }, { - "$ref": "Disks.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -327,29 +327,6 @@ } }, "parameters": { - "SubscriptionIdParameter": { - "name": "subscriptionId", - "in": "path", - "description": "Subscription credentials that uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.", - "required": true, - "type": "string" - }, - "LocationParameter": { - "description": "Location of the resource.", - "name": "location", - "in": "path", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "ApiVersionParameter": { - "name": "api-version", - "in": "query", - "description": "Client API Version.", - "required": true, - "type": "string", - "default": "2021-04-01" - }, "UserSubscriptionIdParameter": { "description": "User Subscription Id which the resource belongs to.", "name": "userSubscriptionId", diff --git a/specification/azsadmin/resource-manager/compute/readme.azsautogen.md b/specification/azsadmin/resource-manager/compute/readme.azsautogen.md index e37ff2fce66c..3c4569631855 100644 --- a/specification/azsadmin/resource-manager/compute/readme.azsautogen.md +++ b/specification/azsadmin/resource-manager/compute/readme.azsautogen.md @@ -6,10 +6,10 @@ input-file: - Microsoft.Compute.Admin/preview/2015-12-01-preview/Compute.json - Microsoft.Compute.Admin/preview/2015-12-01-preview/PlatformImages.json - - Microsoft.Compute.Admin/preview/2018-02-09/Quotas.json - Microsoft.Compute.Admin/preview/2015-12-01-preview/VMExtensions.json - - Microsoft.Compute.Admin/preview/2018-07-30-preview/Disks.json - - Microsoft.Compute.Admin/preview/2018-07-30-preview/DiskMigrationJobs.json + - Microsoft.Compute.Admin/stable/2020-11-01/Features.json + - Microsoft.Compute.Admin/stable/2021-01-01/Quotas.json + - Microsoft.Compute.Admin/stable/2021-03-30/ScaleUnits.json - Microsoft.Compute.Admin/stable/2021-04-01/Disks.json - Microsoft.Compute.Admin/stable/2021-04-01/DiskMigrationJobs.json ``` diff --git a/specification/azsadmin/resource-manager/compute/readme.md b/specification/azsadmin/resource-manager/compute/readme.md index 209e6255a8de..94fc994fddf8 100644 --- a/specification/azsadmin/resource-manager/compute/readme.md +++ b/specification/azsadmin/resource-manager/compute/readme.md @@ -26,22 +26,30 @@ title: ComputeAdminClient description: Compute Admin Client openapi-type: arm tag: package-2021-04-01 + +directive: + - where: + - $.definitions.ScaleUnit + suppress: + - NestedResourcesMustHaveListOperation + reason: + - CRP cannot support the list API for scale units due to the undesired load that would inflict on the system ``` -### Tag: package-2021-03-30 +### Tag: package-2021-04-01 These settings apply only when `--tag=package-2021-04-01` is specified on the command line. ``` yaml $(tag) == 'package-2021-04-01' input-file: - - Microsoft.Compute.Admin/preview/2015-12-01-preview/Compute.json - - Microsoft.Compute.Admin/preview/2015-12-01-preview/PlatformImages.json - - Microsoft.Compute.Admin/preview/2015-12-01-preview/VMExtensions.json - - Microsoft.Compute.Admin/stable/2020-11-01/Features.json - - Microsoft.Compute.Admin/stable/2021-01-01/Quotas.json - - Microsoft.Compute.Admin/stable/2021-03-30/ScaleUnits.json - - Microsoft.Compute.Admin/stable/2021-04-01/Disks.json - - Microsoft.Compute.Admin/stable/2021-04-01/DiskMigrationJobs.json + - Microsoft.Compute.Admin/preview/2015-12-01-preview/Compute.json + - Microsoft.Compute.Admin/preview/2015-12-01-preview/PlatformImages.json + - Microsoft.Compute.Admin/preview/2015-12-01-preview/VMExtensions.json + - Microsoft.Compute.Admin/stable/2020-11-01/Features.json + - Microsoft.Compute.Admin/stable/2021-01-01/Quotas.json + - Microsoft.Compute.Admin/stable/2021-03-30/ScaleUnits.json + - Microsoft.Compute.Admin/stable/2021-04-01/Disks.json + - Microsoft.Compute.Admin/stable/2021-04-01/DiskMigrationJobs.json ``` --- @@ -65,13 +73,14 @@ csharp: ``` yaml input-file: - - Microsoft.Compute.Admin/preview/2015-12-01-preview/Compute.json - - Microsoft.Compute.Admin/preview/2015-12-01-preview/PlatformImages.json - - Microsoft.Compute.Admin/preview/2015-12-01-preview/VMExtensions.json - - Microsoft.Compute.Admin/stable/2020-11-01/Features.json - - Microsoft.Compute.Admin/stable/2021-01-01/Quotas.json - - Microsoft.Compute.Admin/stable/2021-04-01/Disks.json - - Microsoft.Compute.Admin/stable/2021-04-01/DiskMigrationJobs.json + - Microsoft.Compute.Admin/preview/2015-12-01-preview/Compute.json + - Microsoft.Compute.Admin/preview/2015-12-01-preview/PlatformImages.json + - Microsoft.Compute.Admin/preview/2015-12-01-preview/VMExtensions.json + - Microsoft.Compute.Admin/stable/2020-11-01/Features.json + - Microsoft.Compute.Admin/stable/2021-01-01/Quotas.json + - Microsoft.Compute.Admin/stable/2021-03-30/ScaleUnits.json + - Microsoft.Compute.Admin/stable/2021-04-01/Disks.json + - Microsoft.Compute.Admin/stable/2021-04-01/DiskMigrationJobs.json ``` ## Multi-API/Profile support for AutoRest v3 generators @@ -86,15 +95,17 @@ require: $(this-folder)/../../../../profiles/readme.md # all the input files across all versions input-file: - - $(this-folder)/Microsoft.Compute.Admin/preview/2015-12-01-preview/Compute.json - - $(this-folder)/Microsoft.Compute.Admin/preview/2015-12-01-preview/PlatformImages.json - - $(this-folder)/Microsoft.Compute.Admin/preview/2018-02-09/Quotas.json - - $(this-folder)/Microsoft.Compute.Admin/preview/2015-12-01-preview/VMExtensions.json - - $(this-folder)/Microsoft.Compute.Admin/preview/2018-07-30-preview/Disks.json - - $(this-folder)/Microsoft.Compute.Admin/preview/2018-07-30-preview/DiskMigrationJobs.json - - $(this-folder)/Microsoft.Compute.Admin/stable/2021-04-01/Disks.json - - $(this-folder)/Microsoft.Compute.Admin/stable/2021-04-01/DiskMigrationJobs.json - + - $(this-folder)/Microsoft.Compute.Admin/preview/2015-12-01-preview/Compute.json + - $(this-folder)/Microsoft.Compute.Admin/preview/2015-12-01-preview/PlatformImages.json + - $(this-folder)/Microsoft.Compute.Admin/preview/2015-12-01-preview/VMExtensions.json + - $(this-folder)/Microsoft.Compute.Admin/preview/2018-02-09/Quotas.json + - $(this-folder)/Microsoft.Compute.Admin/preview/2018-07-30-preview/Disks.json + - $(this-folder)/Microsoft.Compute.Admin/preview/2018-07-30-preview/DiskMigrationJobs.json + - $(this-folder)/Microsoft.Compute.Admin/stable/2020-11-01/Features.json + - $(this-folder)/Microsoft.Compute.Admin/stable/2021-01-01/Quotas.json + - $(this-folder)/Microsoft.Compute.Admin/stable/2021-03-30/ScaleUnits.json + - $(this-folder)/Microsoft.Compute.Admin/stable/2021-04-01/Disks.json + - $(this-folder)/Microsoft.Compute.Admin/stable/2021-04-01/DiskMigrationJobs.json ``` If there are files that should not be in the `all-api-versions` set, diff --git a/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/preview/2020-08-06-preview/baremetalinfrastructure.json b/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/preview/2020-08-06-preview/baremetalinfrastructure.json index 7e70ac58553f..a49b2e8ca22b 100644 --- a/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/preview/2020-08-06-preview/baremetalinfrastructure.json +++ b/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/preview/2020-08-06-preview/baremetalinfrastructure.json @@ -720,6 +720,7 @@ "description": "Displayed AzureBareMetal operation information" }, "isDataAction": { + "readOnly": true, "description": "indicates whether an operation is a data action or not.", "type": "boolean" } diff --git a/specification/baremetalinfrastructure/resource-manager/readme.go.md b/specification/baremetalinfrastructure/resource-manager/readme.go.md index 3944151a092b..0f7be40125be 100644 --- a/specification/baremetalinfrastructure/resource-manager/readme.go.md +++ b/specification/baremetalinfrastructure/resource-manager/readme.go.md @@ -5,9 +5,17 @@ These settings apply only when `--go` is specified on the command line. ```yaml $(go) go: license-header: MICROSOFT_MIT_NO_VERSION + namespace: baremetalinfrastructure clear-output-folder: true ``` +### Go multi-api + +``` yaml $(go) && $(multiapi) +batch: + - tag: package-2020-08-06-preview +``` + ### Tag: package-2020-08-06-preview and go These settings apply only when `--tag=package-2020-08-06-preview --go` is specified on the command line. diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2021-03-01/compute.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-03-01/compute.json index 7d663a2fc7ee..4bba7558ffa9 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2021-03-01/compute.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-03-01/compute.json @@ -10107,7 +10107,7 @@ }, "certificateUrl": { "type": "string", - "description": "This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see [Add a key or secret to the key vault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8:

{
\"data\":\"\",
\"dataType\":\"pfx\",
\"password\":\"\"
}" + "description": "This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see [Add a key or secret to the key vault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8:

{
\"data\":\"\",
\"dataType\":\"pfx\",
\"password\":\"\"
}
To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows)." } }, "description": "Describes Protocol and thumbprint of Windows Remote Management listener" @@ -10206,7 +10206,7 @@ "properties": { "certificateUrl": { "type": "string", - "description": "This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see [Add a key or secret to the key vault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8:

{
\"data\":\"\",
\"dataType\":\"pfx\",
\"password\":\"\"
}" + "description": "This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see [Add a key or secret to the key vault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8:

{
\"data\":\"\",
\"dataType\":\"pfx\",
\"password\":\"\"
}
To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows)." }, "certificateStore": { "type": "string", @@ -10262,7 +10262,7 @@ "items": { "$ref": "#/definitions/VaultSecretGroup" }, - "description": "Specifies set of certificates that should be installed onto the virtual machine." + "description": "Specifies set of certificates that should be installed onto the virtual machine. To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows)." }, "allowExtensionOperations": { "type": "boolean", @@ -11561,7 +11561,7 @@ "items": { "$ref": "#/definitions/VaultSecretGroup" }, - "description": "Specifies set of certificates that should be installed onto the virtual machines in the scale set." + "description": "Specifies set of certificates that should be installed onto the virtual machines in the scale set. To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows)." } }, "description": "Describes a virtual machine scale set OS profile." diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/compute.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/compute.json index 5e4fb02d0c17..c4f8526dc54f 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/compute.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/compute.json @@ -11022,7 +11022,7 @@ }, "certificateUrl": { "type": "string", - "description": "This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see [Add a key or secret to the key vault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8:

{
\"data\":\"\",
\"dataType\":\"pfx\",
\"password\":\"\"
}" + "description": "This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see [Add a key or secret to the key vault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8:

{
\"data\":\"\",
\"dataType\":\"pfx\",
\"password\":\"\"
}
To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows)." } }, "description": "Describes Protocol and thumbprint of Windows Remote Management listener" @@ -11121,7 +11121,7 @@ "properties": { "certificateUrl": { "type": "string", - "description": "This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see [Add a key or secret to the key vault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8:

{
\"data\":\"\",
\"dataType\":\"pfx\",
\"password\":\"\"
}" + "description": "This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see [Add a key or secret to the key vault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8:

{
\"data\":\"\",
\"dataType\":\"pfx\",
\"password\":\"\"
}
To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows)." }, "certificateStore": { "type": "string", @@ -11177,7 +11177,7 @@ "items": { "$ref": "#/definitions/VaultSecretGroup" }, - "description": "Specifies set of certificates that should be installed onto the virtual machine." + "description": "Specifies set of certificates that should be installed onto the virtual machine. To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows)." }, "allowExtensionOperations": { "type": "boolean", @@ -12494,7 +12494,7 @@ "items": { "$ref": "#/definitions/VaultSecretGroup" }, - "description": "Specifies set of certificates that should be installed onto the virtual machines in the scale set." + "description": "Specifies set of certificates that should be installed onto the virtual machines in the scale set. To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows)." } }, "description": "Describes a virtual machine scale set OS profile." diff --git a/specification/compute/resource-manager/readme.go.md b/specification/compute/resource-manager/readme.go.md index 6241e574fbe1..cf01a327f3da 100644 --- a/specification/compute/resource-manager/readme.go.md +++ b/specification/compute/resource-manager/readme.go.md @@ -2,13 +2,14 @@ These settings apply only when `--go` is specified on the command line. -```yaml $(go) && !(track2) +```yaml $(go) && !$(track2) go: license-header: MICROSOFT_MIT_NO_VERSION clear-output-folder: true directive: - # dynamically add a DummyOrchestrationServiceName value to the enum + # dynamically add a DummyOrchestrationServiceName value to the enum and then remove it from the generated code to avoid the generator generates the code by hard-coding the single-entry enum value + # this directive adds a DummyOrchestrationServiceName to the enum type - from: compute.json where: $..enum transform: >- @@ -17,14 +18,15 @@ directive: } return $; + # this directive removes the DummyOrchestrationServiceName from the generated code, so that we still have only one enum entry in this enum type. - from: source-file-go where: $ transform: >- return $. - replace(/\/\/ DummyOrchestrationServiceName .../g,''). - replace(/DummyOrchestrationServiceName OrchestrationServiceNames = "DummyOrchestrationServiceName"\n/g,''). - replace(/,DummyOrchestrationServiceName/,''). - replace(/, 'DummyOrchestrationServiceName'/,''); + replace(/\/\/ (OrchestrationServiceNames)?DummyOrchestrationServiceName .../g,''). + replace(/(OrchestrationServiceNames)?DummyOrchestrationServiceName OrchestrationServiceNames = "DummyOrchestrationServiceName"\n/g,''). + replace(/,(OrchestrationServiceNames)?DummyOrchestrationServiceName/,''). + replace(/, '(OrchestrationServiceNames)?DummyOrchestrationServiceName'/,''); ``` ``` yaml $(go) && $(track2) @@ -35,6 +37,7 @@ output-folder: $(go-sdk-folder)/$(module-name) azure-arm: true directive: + # we do not need to hack to add a dummy enum entry in track 2, because track 2 generator will generate the enum type even if it only has on entry - from: disk.json where: "$.definitions.PurchasePlan" transform: > diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/AgentPoolsCreate_CustomNodeConfig.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/AgentPoolsCreate_CustomNodeConfig.json new file mode 100644 index 000000000000..7a81e35c0ae8 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/AgentPoolsCreate_CustomNodeConfig.json @@ -0,0 +1,122 @@ +{ + "parameters": { + "api-version": "2021-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "kubeletConfig": { + "cpuManagerPolicy": "static", + "cpuCfsQuota": true, + "cpuCfsQuotaPeriod": "200ms", + "imageGcHighThreshold": 90, + "imageGcLowThreshold": 70, + "topologyManagerPolicy": "best-effort", + "allowedUnsafeSysctls": [ + "kernel.msg*", + "net.core.somaxconn" + ], + "failSwapOn": false + }, + "linuxOSConfig": { + "sysctls": { + "netCoreWmemDefault": 12345, + "netIpv4TcpTwReuse": true, + "netIpv4IpLocalPortRange": "20000 60000", + "kernelThreadsMax": 99999 + }, + "transparentHugePageEnabled": "always", + "transparentHugePageDefrag": "madvise", + "swapFileSizeMB": 1500 + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.17.8", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "kubeletConfig": { + "cpuManagerPolicy": "static", + "cpuCfsQuota": true, + "cpuCfsQuotaPeriod": "200ms", + "imageGcHighThreshold": 90, + "imageGcLowThreshold": 70, + "topologyManagerPolicy": "best-effort", + "allowedUnsafeSysctls": [ + "kernel.msg*", + "net.core.somaxconn" + ], + "failSwapOn": false + }, + "linuxOSConfig": { + "sysctls": { + "netCoreWmemDefault": 12345, + "netIpv4TcpTwReuse": true, + "netIpv4IpLocalPortRange": "20000 60000", + "kernelThreadsMax": 99999 + }, + "transparentHugePageEnabled": "always", + "transparentHugePageDefrag": "madvise", + "swapFileSizeMB": 1500 + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.17.8", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "kubeletConfig": { + "cpuManagerPolicy": "static", + "cpuCfsQuota": true, + "cpuCfsQuotaPeriod": "200ms", + "imageGcHighThreshold": 90, + "imageGcLowThreshold": 70, + "topologyManagerPolicy": "best-effort", + "allowedUnsafeSysctls": [ + "kernel.msg*", + "net.core.somaxconn" + ], + "failSwapOn": false, + "podMaxPids": 100 + }, + "linuxOSConfig": { + "sysctls": { + "netCoreWmemDefault": 65536, + "netIpv4TcpTwReuse": true, + "netIpv4IpLocalPortRange": "20000 60000", + "kernelThreadsMax": 99999 + }, + "transparentHugePageEnabled": "always", + "transparentHugePageDefrag": "madvise", + "swapFileSizeMB": 1500 + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/AgentPoolsCreate_EnableEncryptionAtHost.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/AgentPoolsCreate_EnableEncryptionAtHost.json new file mode 100644 index 000000000000..7bd011745f8a --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/AgentPoolsCreate_EnableEncryptionAtHost.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2021-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "enableEncryptionAtHost": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.17.13", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "enableEncryptionAtHost": true + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.17.13", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "enableEncryptionAtHost": true + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/AgentPoolsCreate_EnableFIPS.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/AgentPoolsCreate_EnableFIPS.json new file mode 100644 index 000000000000..36ad833bed75 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/AgentPoolsCreate_EnableFIPS.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2021-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "enableFIPS": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.19.6", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "enableFIPS": true + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.19.6", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "enableFIPS": true + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/AgentPoolsCreate_EnableUltraSSD.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/AgentPoolsCreate_EnableUltraSSD.json new file mode 100644 index 000000000000..420a94ccdfbe --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/AgentPoolsCreate_EnableUltraSSD.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2021-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "enableUltraSSD": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.17.13", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "enableUltraSSD": true + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.17.13", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "enableUltraSSD": true + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/AgentPoolsCreate_Ephemeral.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/AgentPoolsCreate_Ephemeral.json new file mode 100644 index 000000000000..33e772e6e07d --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/AgentPoolsCreate_Ephemeral.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "api-version": "2021-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "osDiskType": "Ephemeral", + "osDiskSizeGB": 64 + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.17.8", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "osDiskType": "Ephemeral", + "osDiskSizeGB": 64 + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.17.8", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "osDiskType": "Ephemeral", + "kubeletDiskType": "OS", + "osDiskSizeGB": 64 + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/AgentPoolsCreate_GPUMIG.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/AgentPoolsCreate_GPUMIG.json new file mode 100644 index 000000000000..b6d119023c27 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/AgentPoolsCreate_GPUMIG.json @@ -0,0 +1,125 @@ +{ + "parameters": { + "api-version": "2021-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_ND96asr_v4", + "osType": "Linux", + "gpuInstanceProfile": "MIG2g", + "kubeletConfig": { + "cpuManagerPolicy": "static", + "cpuCfsQuota": true, + "cpuCfsQuotaPeriod": "200ms", + "imageGcHighThreshold": 90, + "imageGcLowThreshold": 70, + "topologyManagerPolicy": "best-effort", + "allowedUnsafeSysctls": [ + "kernel.msg*", + "net.core.somaxconn" + ], + "failSwapOn": false + }, + "linuxOSConfig": { + "sysctls": { + "netCoreWmemDefault": 12345, + "netIpv4TcpTwReuse": true, + "netIpv4IpLocalPortRange": "20000 60000", + "kernelThreadsMax": 99999 + }, + "transparentHugePageEnabled": "always", + "transparentHugePageDefrag": "madvise", + "swapFileSizeMB": 1500 + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.17.8", + "count": 3, + "vmSize": "Standard_ND96asr_v4", + "maxPods": 110, + "osType": "Linux", + "gpuInstanceProfile": "MIG2g", + "kubeletConfig": { + "cpuManagerPolicy": "static", + "cpuCfsQuota": true, + "cpuCfsQuotaPeriod": "200ms", + "imageGcHighThreshold": 90, + "imageGcLowThreshold": 70, + "topologyManagerPolicy": "best-effort", + "allowedUnsafeSysctls": [ + "kernel.msg*", + "net.core.somaxconn" + ], + "failSwapOn": false + }, + "linuxOSConfig": { + "sysctls": { + "netCoreWmemDefault": 12345, + "netIpv4TcpTwReuse": true, + "netIpv4IpLocalPortRange": "20000 60000", + "kernelThreadsMax": 99999 + }, + "transparentHugePageEnabled": "always", + "transparentHugePageDefrag": "madvise", + "swapFileSizeMB": 1500 + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.17.8", + "count": 3, + "vmSize": "Standard_ND96asr_v4", + "maxPods": 110, + "osType": "Linux", + "gpuInstanceProfile": "MIG2g", + "kubeletConfig": { + "cpuManagerPolicy": "static", + "cpuCfsQuota": true, + "cpuCfsQuotaPeriod": "200ms", + "imageGcHighThreshold": 90, + "imageGcLowThreshold": 70, + "topologyManagerPolicy": "best-effort", + "allowedUnsafeSysctls": [ + "kernel.msg*", + "net.core.somaxconn" + ], + "failSwapOn": false, + "podMaxPids": 100 + }, + "linuxOSConfig": { + "sysctls": { + "netCoreWmemDefault": 65536, + "netIpv4TcpTwReuse": true, + "netIpv4IpLocalPortRange": "20000 60000", + "kernelThreadsMax": 99999 + }, + "transparentHugePageEnabled": "always", + "transparentHugePageDefrag": "madvise", + "swapFileSizeMB": 1500 + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/AgentPoolsCreate_OSSKU.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/AgentPoolsCreate_OSSKU.json new file mode 100644 index 000000000000..d0685bd412d8 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/AgentPoolsCreate_OSSKU.json @@ -0,0 +1,125 @@ +{ + "parameters": { + "api-version": "2021-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "osSKU": "CBLMariner", + "kubeletConfig": { + "cpuManagerPolicy": "static", + "cpuCfsQuota": true, + "cpuCfsQuotaPeriod": "200ms", + "imageGcHighThreshold": 90, + "imageGcLowThreshold": 70, + "topologyManagerPolicy": "best-effort", + "allowedUnsafeSysctls": [ + "kernel.msg*", + "net.core.somaxconn" + ], + "failSwapOn": false + }, + "linuxOSConfig": { + "sysctls": { + "netCoreWmemDefault": 12345, + "netIpv4TcpTwReuse": true, + "netIpv4IpLocalPortRange": "20000 60000", + "kernelThreadsMax": 99999 + }, + "transparentHugePageEnabled": "always", + "transparentHugePageDefrag": "madvise", + "swapFileSizeMB": 1500 + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.17.8", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "osSKU": "CBLMariner", + "kubeletConfig": { + "cpuManagerPolicy": "static", + "cpuCfsQuota": true, + "cpuCfsQuotaPeriod": "200ms", + "imageGcHighThreshold": 90, + "imageGcLowThreshold": 70, + "topologyManagerPolicy": "best-effort", + "allowedUnsafeSysctls": [ + "kernel.msg*", + "net.core.somaxconn" + ], + "failSwapOn": false + }, + "linuxOSConfig": { + "sysctls": { + "netCoreWmemDefault": 12345, + "netIpv4TcpTwReuse": true, + "netIpv4IpLocalPortRange": "20000 60000", + "kernelThreadsMax": 99999 + }, + "transparentHugePageEnabled": "always", + "transparentHugePageDefrag": "madvise", + "swapFileSizeMB": 1500 + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.17.8", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "osSKU": "CBLMariner", + "kubeletConfig": { + "cpuManagerPolicy": "static", + "cpuCfsQuota": true, + "cpuCfsQuotaPeriod": "200ms", + "imageGcHighThreshold": 90, + "imageGcLowThreshold": 70, + "topologyManagerPolicy": "best-effort", + "allowedUnsafeSysctls": [ + "kernel.msg*", + "net.core.somaxconn" + ], + "failSwapOn": false, + "podMaxPids": 100 + }, + "linuxOSConfig": { + "sysctls": { + "netCoreWmemDefault": 65536, + "netIpv4TcpTwReuse": true, + "netIpv4IpLocalPortRange": "20000 60000", + "kernelThreadsMax": 99999 + }, + "transparentHugePageEnabled": "always", + "transparentHugePageDefrag": "madvise", + "swapFileSizeMB": 1500 + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/AgentPoolsCreate_PPG.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/AgentPoolsCreate_PPG.json new file mode 100644 index 000000000000..c9126120e912 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/AgentPoolsCreate_PPG.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2021-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "proximityPlacementGroupID": "/subscriptions/subid1/resourcegroups/rg1/providers//Microsoft.Compute/proximityPlacementGroups/ppg1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "proximityPlacementGroupID": "/subscriptions/subid1/resourcegroups/rg1/providers//Microsoft.Compute/proximityPlacementGroups/ppg1" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "proximityPlacementGroupID": "/subscriptions/subid1/resourcegroups/rg1/providers//Microsoft.Compute/proximityPlacementGroups/ppg1" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/AgentPoolsCreate_Spot.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/AgentPoolsCreate_Spot.json new file mode 100644 index 000000000000..0d716d389482 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/AgentPoolsCreate_Spot.json @@ -0,0 +1,84 @@ +{ + "parameters": { + "api-version": "2021-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS1_v2", + "osType": "Linux", + "tags": { + "name1": "val1" + }, + "nodeLabels": { + "key1": "val1" + }, + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Spot", + "scaleSetEvictionPolicy": "Delete" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "tags": { + "name1": "val1" + }, + "nodeLabels": { + "key1": "val1" + }, + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Spot", + "scaleSetEvictionPolicy": "Delete", + "spotMaxPrice": -1 + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "tags": { + "name1": "val1" + }, + "nodeLabels": { + "key1": "val1" + }, + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Spot", + "scaleSetEvictionPolicy": "Delete", + "spotMaxPrice": -1 + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/AgentPoolsCreate_Update.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/AgentPoolsCreate_Update.json new file mode 100644 index 000000000000..bfc73da7aa8c --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/AgentPoolsCreate_Update.json @@ -0,0 +1,86 @@ +{ + "parameters": { + "api-version": "2021-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS1_v2", + "osType": "Linux", + "tags": { + "name1": "val1" + }, + "nodeLabels": { + "key1": "val1" + }, + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Spot", + "scaleSetEvictionPolicy": "Delete", + "mode": "User" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "tags": { + "name1": "val1" + }, + "nodeLabels": { + "key1": "val1" + }, + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Spot", + "scaleSetEvictionPolicy": "Delete", + "mode": "User", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "tags": { + "name1": "val1" + }, + "nodeLabels": { + "key1": "val1" + }, + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Spot", + "scaleSetEvictionPolicy": "Delete", + "mode": "User" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/AgentPoolsDelete.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/AgentPoolsDelete.json new file mode 100644 index 000000000000..7abd28274a60 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/AgentPoolsDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2021-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1" + }, + "responses": { + "202": {}, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/AgentPoolsGet.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/AgentPoolsGet.json new file mode 100644 index 000000000000..7115e7bf5908 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/AgentPoolsGet.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2021-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "orchestratorVersion": "1.9.6", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "upgradeSettings": { + "maxSurge": "33%" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/AgentPoolsGetAgentPoolAvailableVersions.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/AgentPoolsGetAgentPoolAvailableVersions.json new file mode 100644 index 000000000000..4b70589ba17c --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/AgentPoolsGetAgentPoolAvailableVersions.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2021-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/availableagentpoolversions", + "name": "default", + "properties": { + "agentPoolVersions": [ + { + "kubernetesVersion": "1.12.7" + }, + { + "kubernetesVersion": "1.12.8" + }, + { + "default": true, + "kubernetesVersion": "1.13.5", + "isPreview": true + } + ] + }, + "type": "Microsoft.ContainerService/managedClusters/availableAgentpoolVersions" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/AgentPoolsGetUpgradeProfile.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/AgentPoolsGetUpgradeProfile.json new file mode 100644 index 000000000000..523ba5165458 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/AgentPoolsGetUpgradeProfile.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2021-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1/upgradeprofiles/default", + "name": "default", + "properties": { + "kubernetesVersion": "1.12.8", + "osType": "Linux", + "upgrades": [ + { + "kubernetesVersion": "1.13.5" + } + ], + "latestNodeImageVersion": "AKSUbuntu:1604:2020.03.11" + }, + "type": "Microsoft.ContainerService/managedClusters/agentPools/upgradeProfiles" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/AgentPoolsList.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/AgentPoolsList.json new file mode 100644 index 000000000000..f6d876b4d9e1 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/AgentPoolsList.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2021-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "orchestratorVersion": "1.9.6", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/AgentPoolsUpgradeNodeImageVersion.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/AgentPoolsUpgradeNodeImageVersion.json new file mode 100644 index 000000000000..80111711caea --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/AgentPoolsUpgradeNodeImageVersion.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2021-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1" + }, + "responses": { + "200": {}, + "202": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "name": "agentpool1", + "properties": { + "provisioningState": "UpgradingNodeImageVersion", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "orchestratorVersion": "1.9.6", + "nodeImageVersion": "AKSUbuntu-1604-2020.03.11", + "upgradeSettings": { + "maxSurge": "33%" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/AgentPools_Update.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/AgentPools_Update.json new file mode 100644 index 000000000000..e22a36fb6619 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/AgentPools_Update.json @@ -0,0 +1,73 @@ +{ + "parameters": { + "api-version": "2021-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "enableAutoScaling": true, + "minCount": 2, + "maxCount": 2, + "vmSize": "Standard_DS1_v2", + "osType": "Linux", + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Spot", + "scaleSetEvictionPolicy": "Delete" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "count": 3, + "enableAutoScaling": true, + "minCount": 2, + "maxCount": 2, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Spot", + "scaleSetEvictionPolicy": "Delete" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Updating", + "orchestratorVersion": "1.9.6", + "count": 3, + "enableAutoScaling": true, + "minCount": 2, + "maxCount": 2, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Spot", + "scaleSetEvictionPolicy": "Delete" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ContainerServiceGetOSOptions.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ContainerServiceGetOSOptions.json new file mode 100644 index 000000000000..81567aad6a93 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ContainerServiceGetOSOptions.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2021-07-01", + "subscriptionId": "subid1", + "location": "location1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/providers/Microsoft.ContainerService/locations/location1/osOptions/default", + "name": "default", + "type": "Microsoft.ContainerService/locations/osOptions", + "properties": { + "osOptionPropertyList": [ + { + "os-type": "Linux", + "enable-fips-image": false + }, + { + "os-type": "Windows", + "enable-fips-image": false + } + ] + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/MaintenanceConfigurationsCreate_Update.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/MaintenanceConfigurationsCreate_Update.json new file mode 100644 index 000000000000..659e202045b2 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/MaintenanceConfigurationsCreate_Update.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "api-version": "2021-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "configName": "default", + "parameters": { + "properties": { + "timeInWeek": [ + { + "day": "Monday", + "hourSlots": [ + 1, + 2 + ] + } + ], + "notAllowedTime": [ + { + "start": "2020-11-26T03:00:00Z", + "end": "2020-11-30T12:00:00Z" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/maintenanceConfigurations/default", + "type": "Microsoft.ContainerService/managedClusters/maintenanceConfigurations", + "name": "default", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "timeInWeek": [ + { + "day": "Monday", + "hourSlots": [ + 1, + 2 + ] + } + ], + "notAllowedTime": [ + { + "start": "2020-11-26T03:00:00Z", + "end": "2020-11-30T12:00:00Z" + } + ] + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/MaintenanceConfigurationsDelete.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/MaintenanceConfigurationsDelete.json new file mode 100644 index 000000000000..252d9d9ec5a1 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/MaintenanceConfigurationsDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2021-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "configName": "default" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/MaintenanceConfigurationsGet.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/MaintenanceConfigurationsGet.json new file mode 100644 index 000000000000..359ad13790ed --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/MaintenanceConfigurationsGet.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2021-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "configName": "default" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/maintenanceConfigurations/default", + "name": "default", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "timeInWeek": [ + { + "day": "Monday", + "hourSlots": [ + 1, + 2 + ] + } + ], + "notAllowedTime": [ + { + "start": "2020-11-26T03:00:00Z", + "end": "2020-11-30T12:00:00Z" + } + ] + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/MaintenanceConfigurationsList.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/MaintenanceConfigurationsList.json new file mode 100644 index 000000000000..10ef8a493b28 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/MaintenanceConfigurationsList.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2021-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/maintenanceConfigurations/default", + "name": "default", + "properties": { + "timeInWeek": [ + { + "day": "Monday", + "hourSlots": [ + 1, + 2 + ] + } + ], + "notAllowedTime": [ + { + "start": "2020-11-26T03:00:00Z", + "end": "2020-11-30T12:00:00Z" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersCreate_EnableEncryptionAtHost.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersCreate_EnableEncryptionAtHost.json new file mode 100644 index 000000000000..9befa3db9ec0 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersCreate_EnableEncryptionAtHost.json @@ -0,0 +1,236 @@ +{ + "parameters": { + "api-version": "2021-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "dockerBridgeCidr": "172.17.0.1/16", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "dockerBridgeCidr": "172.17.0.1/16", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersCreate_EnableUltraSSD.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersCreate_EnableUltraSSD.json new file mode 100644 index 000000000000..c6e275c77fa5 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersCreate_EnableUltraSSD.json @@ -0,0 +1,236 @@ +{ + "parameters": { + "api-version": "2021-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableUltraSSD": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "enableUltraSSD": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "dockerBridgeCidr": "172.17.0.1/16", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableUltraSSD": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "dockerBridgeCidr": "172.17.0.1/16", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersCreate_EnabledFIPS.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersCreate_EnabledFIPS.json new file mode 100644 index 000000000000..87045b6bd58e --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersCreate_EnabledFIPS.json @@ -0,0 +1,236 @@ +{ + "parameters": { + "api-version": "2021-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableFIPS": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": false + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "enableFIPS": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": false, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "dockerBridgeCidr": "172.17.0.1/16", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableFIPS": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": false, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "dockerBridgeCidr": "172.17.0.1/16", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersCreate_GPUMIG.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersCreate_GPUMIG.json new file mode 100644 index 000000000000..7d0e144c3631 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersCreate_GPUMIG.json @@ -0,0 +1,263 @@ +{ + "parameters": { + "api-version": "2021-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_ND96asr_v4", + "osType": "Linux", + "gpuInstanceProfile": "MIG3g", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "httpProxyConfig": { + "httpProxy": "http://myproxy.server.com:8080", + "httpsProxy": "https://myproxy.server.com:8080", + "noProxy": [ + "localhost", + "127.0.0.1" + ], + "trustedCa": "Q29uZ3JhdHMhIFlvdSBoYXZlIGZvdW5kIGEgaGlkZGVuIG1lc3NhZ2U=" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_ND96asr_v4", + "maxPods": 110, + "osType": "Linux", + "gpuInstanceProfile": "MIG3g", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "dockerBridgeCidr": "172.17.0.1/16", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "httpProxyConfig": { + "httpProxy": "http://myproxy.server.com:8080", + "httpsProxy": "https://myproxy.server.com:8080", + "noProxy": [ + "localhost", + "127.0.0.1" + ], + "trustedCa": "Q29uZ3JhdHMhIFlvdSBoYXZlIGZvdW5kIGEgaGlkZGVuIG1lc3NhZ2U=" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_ND96asr_v4", + "maxPods": 110, + "osType": "Linux", + "gpuInstanceProfile": "MIG3g", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "dockerBridgeCidr": "172.17.0.1/16", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "httpProxyConfig": { + "httpProxy": "http://myproxy.server.com:8080", + "httpsProxy": "https://myproxy.server.com:8080", + "noProxy": [ + "localhost", + "127.0.0.1" + ], + "trustedCa": "Q29uZ3JhdHMhIFlvdSBoYXZlIGZvdW5kIGEgaGlkZGVuIG1lc3NhZ2U=" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersCreate_HTTPProxy.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersCreate_HTTPProxy.json new file mode 100644 index 000000000000..9f44b5355fac --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersCreate_HTTPProxy.json @@ -0,0 +1,260 @@ +{ + "parameters": { + "api-version": "2021-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "httpProxyConfig": { + "httpProxy": "http://myproxy.server.com:8080", + "httpsProxy": "https://myproxy.server.com:8080", + "noProxy": [ + "localhost", + "127.0.0.1" + ], + "trustedCa": "Q29uZ3JhdHMhIFlvdSBoYXZlIGZvdW5kIGEgaGlkZGVuIG1lc3NhZ2U=" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "dockerBridgeCidr": "172.17.0.1/16", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "httpProxyConfig": { + "httpProxy": "http://myproxy.server.com:8080", + "httpsProxy": "https://myproxy.server.com:8080", + "noProxy": [ + "localhost", + "127.0.0.1" + ], + "trustedCa": "Q29uZ3JhdHMhIFlvdSBoYXZlIGZvdW5kIGEgaGlkZGVuIG1lc3NhZ2U=" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "dockerBridgeCidr": "172.17.0.1/16", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "httpProxyConfig": { + "httpProxy": "http://myproxy.server.com:8080", + "httpsProxy": "https://myproxy.server.com:8080", + "noProxy": [ + "localhost", + "127.0.0.1" + ], + "trustedCa": "Q29uZ3JhdHMhIFlvdSBoYXZlIGZvdW5kIGEgaGlkZGVuIG1lc3NhZ2U=" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersCreate_ManagedNATGateway.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersCreate_ManagedNATGateway.json new file mode 100644 index 000000000000..273c3967f0c5 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersCreate_ManagedNATGateway.json @@ -0,0 +1,231 @@ +{ + "parameters": { + "api-version": "2021-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": false, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "managedNATGateway", + "natGatewayProfile": { + "managedOutboundIPProfile": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": false, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "dockerBridgeCidr": "172.17.0.1/16", + "outboundType": "managedNATGateway", + "natGatewayProfile": { + "idleTimeoutInMinutes": 4, + "managedOutboundIPProfile": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": false, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "dockerBridgeCidr": "172.17.0.1/16", + "loadBalancerSku": "standard", + "outboundType": "managedNATGateway", + "natGatewayProfile": { + "idleTimeoutInMinutes": 4, + "managedOutboundIPProfile": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersCreate_NodePublicIPPrefix.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersCreate_NodePublicIPPrefix.json new file mode 100644 index 000000000000..c6669505e40f --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersCreate_NodePublicIPPrefix.json @@ -0,0 +1,236 @@ +{ + "parameters": { + "api-version": "2021-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodePublicIPPrefixID": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.Network/publicIPPrefixes/public-ip-prefix" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "nodePublicIPPrefixID": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.Network/publicIPPrefixes/public-ip-prefix" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "dockerBridgeCidr": "172.17.0.1/16", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodePublicIPPrefixID": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.Network/publicIPPrefixes/public-ip-prefix" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "dockerBridgeCidr": "172.17.0.1/16", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersCreate_OSSKU.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersCreate_OSSKU.json new file mode 100644 index 000000000000..0442c3fcbcf4 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersCreate_OSSKU.json @@ -0,0 +1,263 @@ +{ + "parameters": { + "api-version": "2021-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "osSKU": "CBLMariner", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "httpProxyConfig": { + "httpProxy": "http://myproxy.server.com:8080", + "httpsProxy": "https://myproxy.server.com:8080", + "noProxy": [ + "localhost", + "127.0.0.1" + ], + "trustedCa": "Q29uZ3JhdHMhIFlvdSBoYXZlIGZvdW5kIGEgaGlkZGVuIG1lc3NhZ2U=" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "osSKU": "CBLMariner", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "dockerBridgeCidr": "172.17.0.1/16", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "httpProxyConfig": { + "httpProxy": "http://myproxy.server.com:8080", + "httpsProxy": "https://myproxy.server.com:8080", + "noProxy": [ + "localhost", + "127.0.0.1" + ], + "trustedCa": "Q29uZ3JhdHMhIFlvdSBoYXZlIGZvdW5kIGEgaGlkZGVuIG1lc3NhZ2U=" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "osSKU": "CBLMariner", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "dockerBridgeCidr": "172.17.0.1/16", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "httpProxyConfig": { + "httpProxy": "http://myproxy.server.com:8080", + "httpsProxy": "https://myproxy.server.com:8080", + "noProxy": [ + "localhost", + "127.0.0.1" + ], + "trustedCa": "Q29uZ3JhdHMhIFlvdSBoYXZlIGZvdW5kIGEgaGlkZGVuIG1lc3NhZ2U=" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersCreate_PPG.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersCreate_PPG.json new file mode 100644 index 000000000000..bb0a9cff6af5 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersCreate_PPG.json @@ -0,0 +1,236 @@ +{ + "parameters": { + "api-version": "2021-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "proximityPlacementGroupID": "/subscriptions/subid1/resourcegroups/rg1/providers//Microsoft.Compute/proximityPlacementGroups/ppg1" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "proximityPlacementGroupID": "/subscriptions/subid1/resourcegroups/rg1/providers//Microsoft.Compute/proximityPlacementGroups/ppg1" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "dockerBridgeCidr": "172.17.0.1/16", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "proximityPlacementGroupID": "/subscriptions/subid1/resourcegroups/rg1/providers//Microsoft.Compute/proximityPlacementGroups/ppg1" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "dockerBridgeCidr": "172.17.0.1/16", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersCreate_PodIdentity.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersCreate_PodIdentity.json new file mode 100644 index 000000000000..84be13528663 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersCreate_PodIdentity.json @@ -0,0 +1,245 @@ +{ + "parameters": { + "api-version": "2021-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "podIdentityProfile": { + "enabled": true, + "allowNetworkPluginKubenet": true + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "dockerBridgeCidr": "172.17.0.1/16", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "podIdentityProfile": { + "enabled": true, + "allowNetworkPluginKubenet": true + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "dockerBridgeCidr": "172.17.0.1/16", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "podIdentityProfile": { + "enabled": true, + "allowNetworkPluginKubenet": true + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersCreate_PrivateClusterFQDNSubdomain.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersCreate_PrivateClusterFQDNSubdomain.json new file mode 100644 index 000000000000..a1476b36261f --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersCreate_PrivateClusterFQDNSubdomain.json @@ -0,0 +1,246 @@ +{ + "parameters": { + "api-version": "2021-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "fqdnSubdomain": "domain1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "apiServerAccessProfile": { + "enablePrivateCluster": true, + "privateDNSZone": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.Network/privateDnsZones/privatelink.location1.azmk8s.io" + }, + "addonProfiles": {}, + "enableRBAC": true, + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "fqdnSubdomain": "domain1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "apiServerAccessProfile": { + "enablePrivateCluster": true, + "privateDNSZone": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.Network/privateDnsZones/privatelink.location1.azmk8s.io" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "enablePodSecurityPolicy": true, + "privateFQDN": "domain1.privatelink.location1.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "dockerBridgeCidr": "172.17.0.1/16", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "fqdnSubdomain": "domain1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "apiServerAccessProfile": { + "enablePrivateCluster": true, + "privateDNSZone": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.Network/privateDnsZones/privatelink.location1.azmk8s.io" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "privateFQDN": "domain1.privatelink.location1.azmk8s.io", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "dockerBridgeCidr": "172.17.0.1/16", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersCreate_PrivateClusterPublicFQDN.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersCreate_PrivateClusterPublicFQDN.json new file mode 100644 index 000000000000..abfdd1507653 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersCreate_PrivateClusterPublicFQDN.json @@ -0,0 +1,250 @@ +{ + "parameters": { + "api-version": "2021-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "apiServerAccessProfile": { + "enablePrivateCluster": true, + "enablePrivateClusterPublicFQDN": true + }, + "addonProfiles": {}, + "enableRBAC": true, + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "apiServerAccessProfile": { + "enablePrivateCluster": true, + "enablePrivateClusterPublicFQDN": true, + "privateDNSZone": "system" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-ee788a1f.hcp.location1.azmk8s.io", + "privateFQDN": "dnsprefix1-aae7e0f0.5cef6058-b6b5-414d-8cb1-4bd14eb0b15c.privatelink.location1.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "dockerBridgeCidr": "172.17.0.1/16", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "apiServerAccessProfile": { + "enablePrivateCluster": true, + "enablePrivateClusterPublicFQDN": true, + "privateDNSZone": "system" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "fqdn": "dnsprefix1-ee788a1f.hcp.location1.azmk8s.io", + "privateFQDN": "dnsprefix1-aae7e0f0.5cef6058-b6b5-414d-8cb1-4bd14eb0b15c.privatelink.location1.azmk8s.io", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "dockerBridgeCidr": "172.17.0.1/16", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersCreate_SecurityProfile.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersCreate_SecurityProfile.json new file mode 100644 index 000000000000..246b9da63e52 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersCreate_SecurityProfile.json @@ -0,0 +1,227 @@ +{ + "parameters": { + "api-version": "2021-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "securityProfile": { + "azureDefender": { + "enabled": true, + "logAnalyticsWorkspaceResourceId": "/subscriptions/SUB_ID/resourcegroups/RG_NAME/providers/microsoft.operationalinsights/workspaces/WORKSPACE_NAME" + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "dockerBridgeCidr": "172.17.0.1/16", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "securityProfile": { + "azureDefender": { + "enabled": true, + "logAnalyticsWorkspaceResourceId": "/subscriptions/SUB_ID/resourcegroups/RG_NAME/providers/microsoft.operationalinsights/workspaces/WORKSPACE_NAME" + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "dockerBridgeCidr": "172.17.0.1/16", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "securityProfile": { + "azureDefender": { + "enabled": true, + "logAnalyticsWorkspaceResourceId": "/subscriptions/SUB_ID/resourcegroups/RG_NAME/providers/microsoft.operationalinsights/workspaces/WORKSPACE_NAME" + } + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersCreate_Update.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersCreate_Update.json new file mode 100644 index 000000000000..69c71a5ad646 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersCreate_Update.json @@ -0,0 +1,285 @@ +{ + "parameters": { + "api-version": "2021-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "scaleDownMode": "Deallocate", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "balance-similar-node-groups": "true", + "expander": "priority", + "max-node-provision-time": "15m", + "new-pod-scale-up-delay": "1m", + "scale-down-delay-after-add": "15m", + "scan-interval": "20s", + "skip-nodes-with-system-pods": "false" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/subid1/resourceGroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {} + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "scaleDownMode": "Deallocate", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "dockerBridgeCidr": "172.17.0.1/16", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "balance-similar-node-groups": "true", + "expander": "priority", + "max-node-provision-time": "15m", + "new-pod-scale-up-delay": "1m", + "scale-down-delay-after-add": "15m", + "scan-interval": "20s", + "skip-nodes-with-system-pods": "false" + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/subid1/resourceGroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": { + "principalId": "principalId1", + "clientId": "clientId1" + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "scaleDownMode": "Deallocate", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "dockerBridgeCidr": "172.17.0.1/16", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/subid1/resourceGroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": { + "principalId": "principalId1", + "clientId": "clientId1" + } + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersCreate_UpdateWithAHUB.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersCreate_UpdateWithAHUB.json new file mode 100644 index 000000000000..27f72d5fee7e --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersCreate_UpdateWithAHUB.json @@ -0,0 +1,275 @@ +{ + "parameters": { + "api-version": "2021-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$", + "licenseType": "Windows_Server" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/subid1/resourceGroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {} + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser", + "licenseType": "Windows_Server" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "dockerBridgeCidr": "172.17.0.1/16", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/subid1/resourceGroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": { + "principalId": "principalId1", + "clientId": "clientId1" + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser", + "licenseType": "Windows_Server" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "dockerBridgeCidr": "172.17.0.1/16", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/subid1/resourceGroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": { + "principalId": "principalId1", + "clientId": "clientId1" + } + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersCreate_UpdateWithEnableAzureRBAC.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersCreate_UpdateWithEnableAzureRBAC.json new file mode 100644 index 000000000000..aff62fd4fa0b --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersCreate_UpdateWithEnableAzureRBAC.json @@ -0,0 +1,264 @@ +{ + "parameters": { + "api-version": "2021-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "aadProfile": { + "managed": true, + "enableAzureRBAC": true + }, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "dockerBridgeCidr": "172.17.0.1/16", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "aadProfile": { + "managed": true, + "adminGroupObjectIDs": null, + "enableAzureRBAC": true, + "tenantID": "tenantID" + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "dockerBridgeCidr": "172.17.0.1/16", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "aadProfile": { + "managed": true, + "adminGroupObjectIDs": null, + "enableAzureRBAC": true, + "tenantID": "tenantID" + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersCreate_UserAssignedNATGateway.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersCreate_UserAssignedNATGateway.json new file mode 100644 index 000000000000..98c7777dcc27 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersCreate_UserAssignedNATGateway.json @@ -0,0 +1,198 @@ +{ + "parameters": { + "api-version": "2021-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": false, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "userAssignedNATGateway" + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": false, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "dockerBridgeCidr": "172.17.0.1/16", + "outboundType": "userAssignedNATGateway" + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": false, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "dockerBridgeCidr": "172.17.0.1/16", + "loadBalancerSku": "standard", + "outboundType": "userAssignedNATGateway" + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersDelete.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersDelete.json new file mode 100644 index 000000000000..8619884896be --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersDelete.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "api-version": "2021-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "202": {}, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersGet.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersGet.json new file mode 100644 index 000000000000..e16b90a8e161 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersGet.json @@ -0,0 +1,97 @@ +{ + "parameters": { + "api-version": "2021-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "azurePortalFQDN": "dnsprefix1-abcd1234.portal.hcp.eastus.azmk8s.io", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "availabilityZones": [ + "1", + "2", + "3" + ], + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "upgradeSettings": { + "maxSurge": "33%" + } + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": false, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "dockerBridgeCidr": "172.17.0.1/16", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "outboundIPs": { + "publicIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/customeroutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/customeroutboundip2" + } + ] + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersGetAccessProfile.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersGetAccessProfile.json new file mode 100644 index 000000000000..a146c96ba0bc --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersGetAccessProfile.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2021-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "roleName": "clusterUser" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/accessProfiles/clusterUser", + "location": "location1", + "name": "clusterUser", + "properties": { + "kubeConfig": "kubeConfig1" + }, + "type": "Microsoft.ContainerService/ManagedClusters/AccessProfiles" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersGetUpgradeProfile.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersGetUpgradeProfile.json new file mode 100644 index 000000000000..83e19917c07d --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersGetUpgradeProfile.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "api-version": "2021-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/upgradeprofiles/default", + "name": "default", + "properties": { + "agentPoolProfiles": [ + { + "kubernetesVersion": "1.7.7", + "name": "agent", + "osType": "Linux", + "upgrades": [ + { + "kubernetesVersion": "1.7.9" + }, + { + "kubernetesVersion": "1.7.11", + "isPreview": true + } + ] + } + ], + "controlPlaneProfile": { + "kubernetesVersion": "1.7.7", + "name": "master", + "osType": "Linux", + "upgrades": [ + { + "kubernetesVersion": "1.7.9", + "isPreview": true + }, + { + "kubernetesVersion": "1.7.11" + } + ] + } + }, + "type": "Microsoft.ContainerService/managedClusters/upgradeprofiles" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersList.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersList.json new file mode 100644 index 000000000000..114534764189 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersList.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "api-version": "2021-07-01", + "subscriptionId": "subid1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid1/providers/Microsoft.ContainerService/managedClusters", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "kubernetesVersion": "1.9.6", + "maxAgentPools": 1, + "dnsPrefix": "dnsprefix1", + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": false, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "dockerBridgeCidr": "172.17.0.1/16" + } + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersListByResourceGroup.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersListByResourceGroup.json new file mode 100644 index 000000000000..906c34655f43 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersListByResourceGroup.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "api-version": "2021-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "kubernetesVersion": "1.9.6", + "maxAgentPools": 1, + "dnsPrefix": "dnsprefix1", + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": false, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "dockerBridgeCidr": "172.17.0.1/16" + } + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersListClusterCredentialResult.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersListClusterCredentialResult.json new file mode 100644 index 000000000000..610bdce6972a --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersListClusterCredentialResult.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2021-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "kubeconfigs": [ + { + "name": "credentialName1", + "value": "credentialValue1" + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersResetAADProfile.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersResetAADProfile.json new file mode 100644 index 000000000000..d87d79f4ff29 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersResetAADProfile.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2021-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "clientAppID": "clientappid", + "serverAppID": "serverappid", + "serverAppSecret": "serverappsecret", + "tenantID": "tenantid" + } + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersResetServicePrincipalProfile.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersResetServicePrincipalProfile.json new file mode 100644 index 000000000000..8e2c79eb820d --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersResetServicePrincipalProfile.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2021-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "clientId": "clientid", + "secret": "secret" + } + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersRotateClusterCertificates.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersRotateClusterCertificates.json new file mode 100644 index 000000000000..8619884896be --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersRotateClusterCertificates.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "api-version": "2021-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "202": {}, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersStart.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersStart.json new file mode 100644 index 000000000000..8619884896be --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersStart.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "api-version": "2021-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "202": {}, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersStop.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersStop.json new file mode 100644 index 000000000000..8619884896be --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersStop.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "api-version": "2021-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "202": {}, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersUpdateTags.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersUpdateTags.json new file mode 100644 index 000000000000..43fb1d61bbe5 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersUpdateTags.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "api-version": "2021-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "tags": { + "tier": "testing", + "archv3": "" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv3": "", + "tier": "testing" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": false, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "dockerBridgeCidr": "172.17.0.1/16" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/OutboundNetworkDependenciesEndpointsList.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/OutboundNetworkDependenciesEndpointsList.json new file mode 100644 index 000000000000..5ddcd803ef8f --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/OutboundNetworkDependenciesEndpointsList.json @@ -0,0 +1,242 @@ +{ + "parameters": { + "api-version": "2021-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "category": "azure-resource-management", + "endpoints": [ + { + "domainName": "management.azure.com", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https" + } + ] + }, + { + "domainName": "login.microsoftonline.com", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https" + } + ] + } + ] + }, + { + "category": "images", + "endpoints": [ + { + "domainName": "mcr.microsoft.com", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https" + } + ] + }, + { + "domainName": "*.data.mcr.microsoft.com", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https", + "description": "mcr cdn" + } + ] + } + ] + }, + { + "category": "artifacts", + "endpoints": [ + { + "domainName": "packages.microsoft.com", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https" + } + ] + }, + { + "domainName": "acs-mirror.azureedge.net", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https" + } + ] + } + ] + }, + { + "category": "time-sync", + "endpoints": [ + { + "domainName": "ntp.ubuntu.com", + "endpointDetails": [ + { + "port": 123, + "protocol": "UDP" + } + ] + } + ] + }, + { + "category": "ubuntu-optional", + "endpoints": [ + { + "domainName": "security.ubuntu.com", + "endpointDetails": [ + { + "port": 80, + "protocol": "Http" + } + ] + }, + { + "domainName": "azure.archive.ubuntu.com", + "endpointDetails": [ + { + "port": 80, + "protocol": "Http" + } + ] + }, + { + "domainName": "changelogs.ubuntu.com", + "endpointDetails": [ + { + "port": 80, + "protocol": "Http" + } + ] + } + ] + }, + { + "category": "gpu", + "endpoints": [ + { + "domainName": "nvidia.github.io", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https" + } + ] + }, + { + "domainName": "us.download.nvidia.com", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https" + } + ] + }, + { + "domainName": "apt.dockerproject.org", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https" + } + ] + } + ] + }, + { + "category": "windows", + "endpoints": [ + { + "domainName": "onegetcdn.azureedge.net", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https" + } + ] + }, + { + "domainName": "go.microsoft.com", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https" + } + ] + }, + { + "domainName": "*.mp.microsoft.com", + "endpointDetails": [ + { + "port": 80, + "protocol": "Http" + } + ] + }, + { + "domainName": "www.msftconnecttest.com", + "endpointDetails": [ + { + "port": 80, + "protocol": "Http" + } + ] + }, + { + "domainName": "ctldl.windowsupdate.com", + "endpointDetails": [ + { + "port": 80, + "protocol": "Http" + } + ] + } + ] + }, + { + "category": "apiserver", + "endpoints": [ + { + "domainName": "*.azmk8s.io", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https" + } + ] + } + ] + }, + { + "category": "tunnel-classic", + "endpoints": [ + { + "domainName": "*.azmk8s.io", + "endpointDetails": [ + { + "port": 9000, + "protocol": "TCP" + } + ] + } + ] + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/PrivateEndpointConnectionsDelete.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/PrivateEndpointConnectionsDelete.json new file mode 100644 index 000000000000..f3f0d1147be2 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/PrivateEndpointConnectionsDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2021-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "privateEndpointConnectionName": "privateendpointconnection1" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/PrivateEndpointConnectionsGet.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/PrivateEndpointConnectionsGet.json new file mode 100644 index 000000000000..9e553822c7f3 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/PrivateEndpointConnectionsGet.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2021-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "privateEndpointConnectionName": "privateendpointconnection1" + }, + "responses": { + "200": { + "body": { + "properties": { + "privateEndpoint": { + "id": "/subscriptions/subid2/resourceGroups/rg2/providers/Microsoft.Network/privateEndpoints/pe2" + }, + "privateLinkServiceConnectionState": { + "status": "Approved" + }, + "provisioningState": "Succeeded" + }, + "name": "privateendpointconnection1", + "type": "Microsoft.Network/privateLinkServices/privateEndpointConnections" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/PrivateEndpointConnectionsList.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/PrivateEndpointConnectionsList.json new file mode 100644 index 000000000000..c326b66057d2 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/PrivateEndpointConnectionsList.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2021-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "privateEndpoint": { + "id": "/subscriptions/subid2/resourceGroups/rg2/providers/Microsoft.Network/privateEndpoints/pe2" + }, + "privateLinkServiceConnectionState": { + "status": "Approved" + }, + "provisioningState": "Succeeded" + }, + "name": "privateendpointconnection1", + "type": "Microsoft.Network/privateLinkServices/privateEndpointConnections" + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/PrivateEndpointConnectionsUpdate.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/PrivateEndpointConnectionsUpdate.json new file mode 100644 index 000000000000..2597e4561133 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/PrivateEndpointConnectionsUpdate.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2021-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "privateEndpointConnectionName": "privateendpointconnection1", + "parameters": { + "properties": { + "privateLinkServiceConnectionState": { + "status": "Approved" + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "privateEndpoint": { + "id": "/subscriptions/subid2/resourceGroups/rg2/providers/Microsoft.Network/privateEndpoints/pe2" + }, + "privateLinkServiceConnectionState": { + "status": "Approved" + }, + "provisioningState": "Succeeded" + }, + "name": "privateendpointconnection1", + "type": "Microsoft.Network/privateLinkServices/privateEndpointConnections" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/PrivateLinkResourcesList.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/PrivateLinkResourcesList.json new file mode 100644 index 000000000000..917d4b4f846f --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/PrivateLinkResourcesList.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2021-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "management", + "type": "Microsoft.ContainerService/managedClusters/privateLinkResources", + "groupId": "management", + "requiredMembers": [ + "management" + ], + "privateLinkServiceID": "/subscriptions/subid2/resourceGroups/rg2/providers/Microsoft.Network/privateLinkServices/plsName" + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ResolvePrivateLinkServiceId.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ResolvePrivateLinkServiceId.json new file mode 100644 index 000000000000..6ba35d2a6bbf --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ResolvePrivateLinkServiceId.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2021-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "name": "management" + } + }, + "responses": { + "200": { + "body": { + "privateLinkServiceID": "/subscriptions/subid2/resourceGroups/rg2/providers/Microsoft.Network/privateLinkServices/plsName" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/RunCommandRequest.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/RunCommandRequest.json new file mode 100644 index 000000000000..ca1e14b98238 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/RunCommandRequest.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2021-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "requestPayload": { + "command": "kubectl apply -f ns.yaml", + "context": "", + "clusterToken": "" + } + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/commandResults/0e9872e6629349dc865e27ee6f8bab2d?api-version=2021-07-01" + } + }, + "200": { + "description": "to mitigate RESPONSE_STATUS_CODE_NOT_IN_EXAMPLE", + "body": { + "id": "def7b3ea71bd4f7e9d226ddbc0f00ad9", + "properties": { + "provisioningState": "succeeded", + "exitCode": 0, + "startedAt": "2021-02-17T00:28:20Z", + "finishedAt": "2021-02-17T00:28:33Z", + "logs": "namespace dummy created" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/RunCommandResultFailed.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/RunCommandResultFailed.json new file mode 100644 index 000000000000..39245dc8c6f9 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/RunCommandResultFailed.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2021-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "commandId": "def7b3ea71bd4f7e9d226ddbc0f00ad9" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/commandResults/0e9872e6629349dc865e27ee6f8bab2d?api-version=2021-07-01" + } + }, + "200": { + "body": { + "id": "def7b3ea71bd4f7e9d226ddbc0f00ad9", + "properties": { + "provisioningState": "failed", + "reason": "ImagePullBackoff" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/RunCommandResultSucceed.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/RunCommandResultSucceed.json new file mode 100644 index 000000000000..a573f93953ed --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/RunCommandResultSucceed.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2021-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "commandId": "def7b3ea71bd4f7e9d226ddbc0f00ad9" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/commandResults/0e9872e6629349dc865e27ee6f8bab2d?api-version=2021-07-01" + } + }, + "200": { + "body": { + "id": "def7b3ea71bd4f7e9d226ddbc0f00ad9", + "properties": { + "provisioningState": "succeeded", + "exitCode": 0, + "startedAt": "2021-02-17T00:28:20Z", + "finishedAt": "2021-02-17T00:28:33Z", + "logs": "namespace dummy created" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/managedClusters.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/managedClusters.json new file mode 100644 index 000000000000..8ff720f12f79 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/managedClusters.json @@ -0,0 +1,5109 @@ +{ + "swagger": "2.0", + "info": { + "title": "ContainerServiceClient", + "description": "The Container Service Client.", + "version": "2021-07-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/providers/Microsoft.ContainerService/operations": { + "get": { + "tags": [ + "managedClusters" + ], + "operationId": "Operations_List", + "summary": "Gets a list of operations.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/locations/{location}/osOptions/default": { + "get": { + "tags": [ + "managedClusters" + ], + "operationId": "ManagedClusters_GetOSOptions", + "summary": "Gets supported OS options in the specified subscription.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/LocationParameter" + }, + { + "$ref": "#/parameters/ResourceTypeParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/CloudError" + } + }, + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OSOptionProfile" + } + } + }, + "x-ms-examples": { + "Get Container Service OS Options": { + "$ref": "./examples/ContainerServiceGetOSOptions.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/managedClusters": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_List", + "summary": "Gets a list of managed clusters in the specified subscription.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedClusterListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List Managed Clusters": { + "$ref": "./examples/ManagedClustersList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ListByResourceGroup", + "summary": "Lists managed clusters in the specified subscription and resource group.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedClusterListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Get Managed Clusters by Resource Group": { + "$ref": "./examples/ManagedClustersListByResourceGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/upgradeProfiles/default": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_GetUpgradeProfile", + "summary": "Gets the upgrade profile of a managed cluster.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedClusterUpgradeProfile" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Upgrade Profile for Managed Cluster": { + "$ref": "./examples/ManagedClustersGetUpgradeProfile.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/accessProfiles/{roleName}/listCredential": { + "post": { + "deprecated": true, + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_GetAccessProfile", + "summary": "Gets an access profile of a managed cluster.", + "description": "**WARNING**: This API will be deprecated. Instead use [ListClusterUserCredentials](https://docs.microsoft.com/rest/api/aks/managedclusters/listclusterusercredentials) or [ListClusterAdminCredentials](https://docs.microsoft.com/rest/api/aks/managedclusters/listclusteradmincredentials) .", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "roleName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the role for managed cluster accessProfile resource." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedClusterAccessProfile" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Managed Cluster": { + "$ref": "./examples/ManagedClustersGetAccessProfile.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/listClusterAdminCredential": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ListClusterAdminCredentials", + "summary": "Lists the admin credentials of a managed cluster.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/ServerFqdnParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CredentialResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Managed Cluster": { + "$ref": "./examples/ManagedClustersListClusterCredentialResult.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/listClusterUserCredential": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ListClusterUserCredentials", + "summary": "Lists the user credentials of a managed cluster.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/ServerFqdnParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CredentialResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Managed Cluster": { + "$ref": "./examples/ManagedClustersListClusterCredentialResult.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/listClusterMonitoringUserCredential": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ListClusterMonitoringUserCredentials", + "summary": "Lists the cluster monitoring user credentials of a managed cluster.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/ServerFqdnParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CredentialResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Managed Cluster": { + "$ref": "./examples/ManagedClustersListClusterCredentialResult.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_Get", + "summary": "Gets a managed cluster.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedCluster" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Managed Cluster": { + "$ref": "./examples/ManagedClustersGet.json" + } + } + }, + "put": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_CreateOrUpdate", + "summary": "Creates or updates a managed cluster.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ManagedCluster" + }, + "description": "The managed cluster to create or update." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedCluster" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/ManagedCluster" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create/Update Managed Cluster": { + "$ref": "./examples/ManagedClustersCreate_Update.json" + }, + "Create/Update AAD Managed Cluster with EnableAzureRBAC": { + "$ref": "./examples/ManagedClustersCreate_UpdateWithEnableAzureRBAC.json" + }, + "Create Managed Cluster with PPG": { + "$ref": "./examples/ManagedClustersCreate_PPG.json" + }, + "Create Managed Cluster with OSSKU": { + "$ref": "./examples/ManagedClustersCreate_OSSKU.json" + }, + "Create Managed Cluster with GPUMIG": { + "$ref": "./examples/ManagedClustersCreate_GPUMIG.json" + }, + "Create/Update Managed Cluster with EnableAHUB": { + "$ref": "./examples/ManagedClustersCreate_UpdateWithAHUB.json" + }, + "Create Managed Cluster with EncryptionAtHost enabled": { + "$ref": "./examples/ManagedClustersCreate_EnableEncryptionAtHost.json" + }, + "Create Managed Cluster with UltraSSD enabled": { + "$ref": "./examples/ManagedClustersCreate_EnableUltraSSD.json" + }, + "Create Managed Cluster with PodIdentity enabled": { + "$ref": "./examples/ManagedClustersCreate_PodIdentity.json" + }, + "Create Managed Private Cluster with fqdn subdomain specified": { + "$ref": "./examples/ManagedClustersCreate_PrivateClusterFQDNSubdomain.json" + }, + "Create Managed Private Cluster with Public FQDN specified": { + "$ref": "./examples/ManagedClustersCreate_PrivateClusterPublicFQDN.json" + }, + "Create Managed Cluster with Node Public IP Prefix": { + "$ref": "./examples/ManagedClustersCreate_NodePublicIPPrefix.json" + }, + "Create Managed Cluster with FIPS enabled OS": { + "$ref": "./examples/ManagedClustersCreate_EnabledFIPS.json" + }, + "Create Managed Cluster with HTTP proxy configured": { + "$ref": "./examples/ManagedClustersCreate_HTTPProxy.json" + }, + "Create Managed Cluster with Security Profile configured": { + "$ref": "./examples/ManagedClustersCreate_SecurityProfile.json" + }, + "Create Managed Cluster with AKS-managed NAT gateway as outbound type": { + "$ref": "./examples/ManagedClustersCreate_ManagedNATGateway.json" + }, + "Create Managed Cluster with user-assigned NAT gateway as outbound type": { + "$ref": "./examples/ManagedClustersCreate_UserAssignedNATGateway.json" + } + } + }, + "patch": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_UpdateTags", + "summary": "Updates tags on a managed cluster.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/TagsObject" + }, + "description": "Parameters supplied to the Update Managed Cluster Tags operation." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedCluster" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update Managed Cluster Tags": { + "$ref": "./examples/ManagedClustersUpdateTags.json" + } + } + }, + "delete": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_Delete", + "summary": "Deletes a managed cluster.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete Managed Cluster": { + "$ref": "./examples/ManagedClustersDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/maintenanceConfigurations": { + "get": { + "tags": [ + "MaintenanceConfigurations" + ], + "operationId": "MaintenanceConfigurations_ListByManagedCluster", + "summary": "Gets a list of maintenance configurations in the specified managed cluster.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MaintenanceConfigurationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List maintenance configurations by Managed Cluster": { + "$ref": "./examples/MaintenanceConfigurationsList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/maintenanceConfigurations/{configName}": { + "get": { + "tags": [ + "MaintenanceConfigurations" + ], + "operationId": "MaintenanceConfigurations_Get", + "summary": "Gets the specified maintenance configuration of a managed cluster.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "configName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the maintenance configuration." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MaintenanceConfiguration" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Maintenance Configuration": { + "$ref": "./examples/MaintenanceConfigurationsGet.json" + } + } + }, + "put": { + "tags": [ + "MaintenanceConfigurations" + ], + "operationId": "MaintenanceConfigurations_CreateOrUpdate", + "summary": "Creates or updates a maintenance configuration in the specified managed cluster.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "configName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the maintenance configuration." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MaintenanceConfiguration" + }, + "description": "The maintenance configuration to create or update." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MaintenanceConfiguration" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": false, + "x-ms-examples": { + "Create/Update Maintenance Configuration": { + "$ref": "./examples/MaintenanceConfigurationsCreate_Update.json" + } + } + }, + "delete": { + "tags": [ + "MaintenanceConfigurations" + ], + "operationId": "MaintenanceConfigurations_Delete", + "summary": "Deletes a maintenance configuration.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "configName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the maintenance configuration." + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": false, + "x-ms-examples": { + "Delete Maintenance Configuration": { + "$ref": "./examples/MaintenanceConfigurationsDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools": { + "get": { + "tags": [ + "AgentPools" + ], + "operationId": "AgentPools_List", + "summary": "Gets a list of agent pools in the specified managed cluster.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AgentPoolListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List Agent Pools by Managed Cluster": { + "$ref": "./examples/AgentPoolsList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}": { + "get": { + "tags": [ + "AgentPools" + ], + "operationId": "AgentPools_Get", + "summary": "Gets the specified managed cluster agent pool.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "agentPoolName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the agent pool." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AgentPool" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Agent Pool": { + "$ref": "./examples/AgentPoolsGet.json" + } + } + }, + "put": { + "tags": [ + "AgentPools" + ], + "operationId": "AgentPools_CreateOrUpdate", + "summary": "Creates or updates an agent pool in the specified managed cluster.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "agentPoolName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the agent pool." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AgentPool" + }, + "description": "The agent pool to create or update." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AgentPool" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/AgentPool" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create/Update Agent Pool": { + "$ref": "./examples/AgentPoolsCreate_Update.json" + }, + "Update Agent Pool": { + "$ref": "./examples/AgentPools_Update.json" + }, + "Create Spot Agent Pool": { + "$ref": "./examples/AgentPoolsCreate_Spot.json" + }, + "Create Agent Pool with PPG": { + "$ref": "./examples/AgentPoolsCreate_PPG.json" + }, + "Create Agent Pool with OSSKU": { + "$ref": "./examples/AgentPoolsCreate_OSSKU.json" + }, + "Create Agent Pool with GPUMIG": { + "$ref": "./examples/AgentPoolsCreate_GPUMIG.json" + }, + "Create Agent Pool with Ephemeral OS Disk": { + "$ref": "./examples/AgentPoolsCreate_Ephemeral.json" + }, + "Create Agent Pool with KubeletConfig and LinuxOSConfig": { + "$ref": "./examples/AgentPoolsCreate_CustomNodeConfig.json" + }, + "Create Agent Pool with EncryptionAtHost enabled": { + "$ref": "./examples/AgentPoolsCreate_EnableEncryptionAtHost.json" + }, + "Create Agent Pool with UltraSSD enabled": { + "$ref": "./examples/AgentPoolsCreate_EnableUltraSSD.json" + }, + "Create Agent Pool with FIPS enabled OS": { + "$ref": "./examples/AgentPoolsCreate_EnableFIPS.json" + } + } + }, + "delete": { + "tags": [ + "AgentPools" + ], + "operationId": "AgentPools_Delete", + "summary": "Deletes an agent pool in the specified managed cluster.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "agentPoolName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the agent pool." + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete Agent Pool": { + "$ref": "./examples/AgentPoolsDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}/upgradeProfiles/default": { + "get": { + "tags": [ + "AgentPools" + ], + "operationId": "AgentPools_GetUpgradeProfile", + "summary": "Gets the upgrade profile for an agent pool.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "agentPoolName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the agent pool." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AgentPoolUpgradeProfile" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Upgrade Profile for Agent Pool": { + "$ref": "./examples/AgentPoolsGetUpgradeProfile.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/availableAgentPoolVersions": { + "get": { + "tags": [ + "AgentPools" + ], + "operationId": "AgentPools_GetAvailableAgentPoolVersions", + "summary": "Gets a list of supported Kubernetes versions for the specified agent pool.", + "description": "See [supported Kubernetes versions](https://docs.microsoft.com/azure/aks/supported-kubernetes-versions) for more details about the version lifecycle.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AgentPoolAvailableVersions" + } + } + }, + "x-ms-examples": { + "Get available versions for agent pool": { + "$ref": "./examples/AgentPoolsGetAgentPoolAvailableVersions.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/resetServicePrincipalProfile": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ResetServicePrincipalProfile", + "summary": "Reset the Service Principal Profile of a managed cluster.", + "description": "This action cannot be performed on a cluster that is not using a service principal", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ManagedClusterServicePrincipalProfile" + }, + "description": "The service principal profile to set on the managed cluster." + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed. If the cluster doesn't exist, 404 (Not found) is returned.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Reset Service Principal Profile": { + "$ref": "./examples/ManagedClustersResetServicePrincipalProfile.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/resetAADProfile": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ResetAADProfile", + "summary": "Reset the AAD Profile of a managed cluster.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ManagedClusterAADProfile" + }, + "description": "The AAD profile to set on the Managed Cluster" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed. If the cluster doesn't exist, 404 (Not found) is returned.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Reset AAD Profile": { + "$ref": "./examples/ManagedClustersResetAADProfile.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/rotateClusterCertificates": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_RotateClusterCertificates", + "summary": "Rotates the certificates of a managed cluster.", + "description": "See [Certificate rotation](https://docs.microsoft.com/azure/aks/certificate-rotation) for more details about rotating managed cluster certificates.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed. If the cluster doesn't exist, 404 (Not found) is returned.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Rotate Cluster Certificates": { + "$ref": "./examples/ManagedClustersRotateClusterCertificates.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/stop": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_Stop", + "summary": "Stops a Managed Cluster", + "description": "This can only be performed on Azure Virtual Machine Scale set backed clusters. Stopping a cluster stops the control plane and agent nodes entirely, while maintaining all object and cluster state. A cluster does not accrue charges while it is stopped. See [stopping a cluster](https://docs.microsoft.com/azure/aks/start-stop-cluster) for more details about stopping a cluster.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed. If the cluster doesn't exist, 404 (Not found) is returned.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Stop Managed Cluster": { + "$ref": "./examples/ManagedClustersStop.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/start": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_Start", + "summary": "Starts a previously stopped Managed Cluster", + "description": "See [starting a cluster](https://docs.microsoft.com/azure/aks/start-stop-cluster) for more details about starting a cluster.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed. If the cluster doesn't exist, 404 (Not found) is returned.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Start Managed Cluster": { + "$ref": "./examples/ManagedClustersStart.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/privateEndpointConnections": { + "get": { + "tags": [ + "PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_List", + "summary": "Gets a list of private endpoint connections in the specified managed cluster.", + "description": "To learn more about private clusters, see: https://docs.microsoft.com/azure/aks/private-clusters", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List Private Endpoint Connections by Managed Cluster": { + "$ref": "./examples/PrivateEndpointConnectionsList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}": { + "get": { + "tags": [ + "PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_Get", + "summary": "Gets the specified private endpoint connection.", + "description": "To learn more about private clusters, see: https://docs.microsoft.com/azure/aks/private-clusters", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "privateEndpointConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the private endpoint connection." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Private Endpoint Connection": { + "$ref": "./examples/PrivateEndpointConnectionsGet.json" + } + } + }, + "put": { + "tags": [ + "PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_Update", + "summary": "Updates a private endpoint connection.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "privateEndpointConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the private endpoint connection." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + }, + "description": "The updated private endpoint connection." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Update Private Endpoint Connection": { + "$ref": "./examples/PrivateEndpointConnectionsUpdate.json" + } + } + }, + "delete": { + "tags": [ + "PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_Delete", + "summary": "Deletes a private endpoint connection.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "privateEndpointConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the private endpoint connection." + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content -- The private endpoint connection does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete Private Endpoint Connection": { + "$ref": "./examples/PrivateEndpointConnectionsDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}/upgradeNodeImageVersion": { + "post": { + "tags": [ + "AgentPools" + ], + "operationId": "AgentPools_UpgradeNodeImageVersion", + "summary": "Upgrades the node image version of an agent pool to the latest.", + "description": "Upgrading the node image version of an agent pool applies the newest OS and runtime updates to the nodes. AKS provides one new image per week with the latest updates. For more details on node image versions, see: https://docs.microsoft.com/azure/aks/node-image-upgrade", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "agentPoolName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the agent pool." + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/AgentPool" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Upgrade Agent Pool Node Image Version": { + "$ref": "./examples/AgentPoolsUpgradeNodeImageVersion.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/privateLinkResources": { + "get": { + "tags": [ + "privateLinkResources" + ], + "operationId": "PrivateLinkResources_List", + "summary": "Gets a list of private link resources in the specified managed cluster.", + "description": "To learn more about private clusters, see: https://docs.microsoft.com/azure/aks/private-clusters", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PrivateLinkResourcesListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List Private Link Resources by Managed Cluster": { + "$ref": "./examples/PrivateLinkResourcesList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/resolvePrivateLinkServiceId": { + "post": { + "tags": [ + "resolvePrivateLinkServiceId" + ], + "operationId": "ResolvePrivateLinkServiceId_POST", + "summary": "Gets the private link service ID for the specified managed cluster.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateLinkResource" + }, + "description": "Parameters required in order to resolve a private link service ID." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PrivateLinkResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Resolve the Private Link Service ID for Managed Cluster": { + "$ref": "./examples/ResolvePrivateLinkServiceId.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/runCommand": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_RunCommand", + "summary": "Submits a command to run against the Managed Cluster.", + "description": "AKS will create a pod to run the command. This is primarily useful for private clusters. For more information see [AKS Run Command](https://docs.microsoft.com/azure/aks/private-clusters#aks-run-command-preview).", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "requestPayload", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RunCommandRequest" + }, + "description": "The run command request" + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "200": { + "description": "command finished with async pattern, tracking by location header. !!! this is for autorest only, you never get 200 from this api !!!", + "schema": { + "$ref": "#/definitions/RunCommandResult" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the cluster doesn't exist, 404 (Not found) is returned.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "submitNewCommand": { + "$ref": "./examples/RunCommandRequest.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/commandResults/{commandId}": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_GetCommandResult", + "summary": "Gets the results of a command which has been run on the Managed Cluster.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "commandId", + "in": "path", + "required": true, + "type": "string", + "description": "Id of the command." + } + ], + "responses": { + "202": { + "description": "command running in progress" + }, + "200": { + "description": "command finished", + "schema": { + "$ref": "#/definitions/RunCommandResult" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the cluster doesn't exist, 404 (Not found) is returned.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "commandSucceedResult": { + "$ref": "./examples/RunCommandResultSucceed.json" + }, + "commandFailedResult": { + "$ref": "./examples/RunCommandResultFailed.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/outboundNetworkDependenciesEndpoints": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ListOutboundNetworkDependenciesEndpoints", + "summary": "Gets a list of egress endpoints (network endpoints of all outbound dependencies) in the specified managed cluster.", + "description": "Gets a list of egress endpoints (network endpoints of all outbound dependencies) in the specified managed cluster. The operation returns properties of each egress endpoint.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OutboundEnvironmentEndpointCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List OutboundNetworkDependenciesEndpoints by Managed Cluster": { + "$ref": "./examples/OutboundNetworkDependenciesEndpointsList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "OperationListResult": { + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/OperationValue" + }, + "description": "The list of operations" + } + }, + "description": "The List Operation response." + }, + "OperationValue": { + "properties": { + "origin": { + "type": "string", + "readOnly": true, + "description": "The origin of the operation." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "The name of the operation." + }, + "display": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/OperationValueDisplay", + "description": "Describes the properties of a Operation Value Display." + } + }, + "description": "Describes the properties of a Operation value." + }, + "OperationValueDisplay": { + "properties": { + "operation": { + "type": "string", + "readOnly": true, + "description": "The display name of the operation." + }, + "resource": { + "type": "string", + "readOnly": true, + "description": "The display name of the resource the operation applies to." + }, + "description": { + "type": "string", + "readOnly": true, + "description": "The description of the operation." + }, + "provider": { + "type": "string", + "readOnly": true, + "description": "The resource provider for the operation." + } + }, + "description": "Describes the properties of a Operation Value Display." + }, + "Resource": { + "description": "The Resource model definition.", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Resource Id" + }, + "name": { + "readOnly": true, + "type": "string", + "description": "Resource name" + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type" + }, + "location": { + "type": "string", + "description": "Resource location", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + } + }, + "required": [ + "location" + ], + "x-ms-azure-resource": true + }, + "SubResource": { + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Resource ID." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type" + } + }, + "description": "Reference to another subresource.", + "x-ms-azure-resource": true + }, + "TagsObject": { + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags." + } + }, + "description": "Tags object for patch operations." + }, + "ContainerServiceOSDisk": { + "type": "integer", + "format": "int32", + "maximum": 2048, + "minimum": 0, + "description": "OS Disk Size in GB to be used to specify the disk size for every machine in the master/agent pool. If you specify 0, it will apply the default osDisk size according to the vmSize specified." + }, + "ContainerServiceStorageProfile": { + "type": "string", + "x-ms-enum": { + "name": "ContainerServiceStorageProfileTypes", + "modelAsString": true + }, + "enum": [ + "StorageAccount", + "ManagedDisks" + ], + "description": "Specifies what kind of storage to use. If omitted, the default will be chosen on your behalf based on the choice of orchestrator." + }, + "ContainerServiceVnetSubnetID": { + "type": "string", + "description": "specifies a subnet's resource id with subscription, resource group, vnet and subnet name" + }, + "ContainerServiceVMSize": { + "type": "string", + "x-ms-enum": { + "name": "ContainerServiceVMSizeTypes", + "modelAsString": true + }, + "description": "Size of agent VMs. Note: This is no longer maintained.", + "enum": [ + "Standard_A1", + "Standard_A10", + "Standard_A11", + "Standard_A1_v2", + "Standard_A2", + "Standard_A2_v2", + "Standard_A2m_v2", + "Standard_A3", + "Standard_A4", + "Standard_A4_v2", + "Standard_A4m_v2", + "Standard_A5", + "Standard_A6", + "Standard_A7", + "Standard_A8", + "Standard_A8_v2", + "Standard_A8m_v2", + "Standard_A9", + "Standard_B2ms", + "Standard_B2s", + "Standard_B4ms", + "Standard_B8ms", + "Standard_D1", + "Standard_D11", + "Standard_D11_v2", + "Standard_D11_v2_Promo", + "Standard_D12", + "Standard_D12_v2", + "Standard_D12_v2_Promo", + "Standard_D13", + "Standard_D13_v2", + "Standard_D13_v2_Promo", + "Standard_D14", + "Standard_D14_v2", + "Standard_D14_v2_Promo", + "Standard_D15_v2", + "Standard_D16_v3", + "Standard_D16s_v3", + "Standard_D1_v2", + "Standard_D2", + "Standard_D2_v2", + "Standard_D2_v2_Promo", + "Standard_D2_v3", + "Standard_D2s_v3", + "Standard_D3", + "Standard_D32_v3", + "Standard_D32s_v3", + "Standard_D3_v2", + "Standard_D3_v2_Promo", + "Standard_D4", + "Standard_D4_v2", + "Standard_D4_v2_Promo", + "Standard_D4_v3", + "Standard_D4s_v3", + "Standard_D5_v2", + "Standard_D5_v2_Promo", + "Standard_D64_v3", + "Standard_D64s_v3", + "Standard_D8_v3", + "Standard_D8s_v3", + "Standard_DS1", + "Standard_DS11", + "Standard_DS11_v2", + "Standard_DS11_v2_Promo", + "Standard_DS12", + "Standard_DS12_v2", + "Standard_DS12_v2_Promo", + "Standard_DS13", + "Standard_DS13-2_v2", + "Standard_DS13-4_v2", + "Standard_DS13_v2", + "Standard_DS13_v2_Promo", + "Standard_DS14", + "Standard_DS14-4_v2", + "Standard_DS14-8_v2", + "Standard_DS14_v2", + "Standard_DS14_v2_Promo", + "Standard_DS15_v2", + "Standard_DS1_v2", + "Standard_DS2", + "Standard_DS2_v2", + "Standard_DS2_v2_Promo", + "Standard_DS3", + "Standard_DS3_v2", + "Standard_DS3_v2_Promo", + "Standard_DS4", + "Standard_DS4_v2", + "Standard_DS4_v2_Promo", + "Standard_DS5_v2", + "Standard_DS5_v2_Promo", + "Standard_E16_v3", + "Standard_E16s_v3", + "Standard_E2_v3", + "Standard_E2s_v3", + "Standard_E32-16s_v3", + "Standard_E32-8s_v3", + "Standard_E32_v3", + "Standard_E32s_v3", + "Standard_E4_v3", + "Standard_E4s_v3", + "Standard_E64-16s_v3", + "Standard_E64-32s_v3", + "Standard_E64_v3", + "Standard_E64s_v3", + "Standard_E8_v3", + "Standard_E8s_v3", + "Standard_F1", + "Standard_F16", + "Standard_F16s", + "Standard_F16s_v2", + "Standard_F1s", + "Standard_F2", + "Standard_F2s", + "Standard_F2s_v2", + "Standard_F32s_v2", + "Standard_F4", + "Standard_F4s", + "Standard_F4s_v2", + "Standard_F64s_v2", + "Standard_F72s_v2", + "Standard_F8", + "Standard_F8s", + "Standard_F8s_v2", + "Standard_G1", + "Standard_G2", + "Standard_G3", + "Standard_G4", + "Standard_G5", + "Standard_GS1", + "Standard_GS2", + "Standard_GS3", + "Standard_GS4", + "Standard_GS4-4", + "Standard_GS4-8", + "Standard_GS5", + "Standard_GS5-16", + "Standard_GS5-8", + "Standard_H16", + "Standard_H16m", + "Standard_H16mr", + "Standard_H16r", + "Standard_H8", + "Standard_H8m", + "Standard_L16s", + "Standard_L32s", + "Standard_L4s", + "Standard_L8s", + "Standard_M128-32ms", + "Standard_M128-64ms", + "Standard_M128ms", + "Standard_M128s", + "Standard_M64-16ms", + "Standard_M64-32ms", + "Standard_M64ms", + "Standard_M64s", + "Standard_NC12", + "Standard_NC12s_v2", + "Standard_NC12s_v3", + "Standard_NC24", + "Standard_NC24r", + "Standard_NC24rs_v2", + "Standard_NC24rs_v3", + "Standard_NC24s_v2", + "Standard_NC24s_v3", + "Standard_NC6", + "Standard_NC6s_v2", + "Standard_NC6s_v3", + "Standard_ND12s", + "Standard_ND24rs", + "Standard_ND24s", + "Standard_ND6s", + "Standard_NV12", + "Standard_NV24", + "Standard_NV6" + ] + }, + "ManagedClusterServicePrincipalProfile": { + "properties": { + "clientId": { + "type": "string", + "description": "The ID for the service principal." + }, + "secret": { + "type": "string", + "description": "The secret password associated with the service principal in plain text." + } + }, + "description": "Information about a service principal identity for the cluster to use for manipulating Azure APIs.", + "required": [ + "clientId" + ] + }, + "ContainerServiceMasterProfile": { + "properties": { + "count": { + "type": "integer", + "format": "int32", + "enum": [ + 1, + 3, + 5 + ], + "x-ms-enum": { + "name": "Count", + "modelAsString": false + }, + "description": "Number of masters (VMs) in the container service cluster. Allowed values are 1, 3, and 5. The default value is 1.", + "default": 1 + }, + "dnsPrefix": { + "type": "string", + "description": "DNS prefix to be used to create the FQDN for the master pool." + }, + "vmSize": { + "$ref": "#/definitions/ContainerServiceVMSize", + "description": "Size of agent VMs." + }, + "osDiskSizeGB": { + "$ref": "#/definitions/ContainerServiceOSDisk", + "description": "OS Disk Size in GB to be used to specify the disk size for every machine in this master/agent pool. If you specify 0, it will apply the default osDisk size according to the vmSize specified." + }, + "vnetSubnetID": { + "$ref": "#/definitions/ContainerServiceVnetSubnetID", + "description": "VNet SubnetID specifies the VNet's subnet identifier." + }, + "firstConsecutiveStaticIP": { + "type": "string", + "description": "FirstConsecutiveStaticIP used to specify the first static ip of masters.", + "default": "10.240.255.5" + }, + "storageProfile": { + "$ref": "#/definitions/ContainerServiceStorageProfile", + "description": "Storage profile specifies what kind of storage used. Choose from StorageAccount and ManagedDisks. Leave it empty, we will choose for you based on the orchestrator choice." + }, + "fqdn": { + "readOnly": true, + "type": "string", + "description": "FQDN for the master pool." + } + }, + "required": [ + "dnsPrefix", + "vmSize" + ], + "description": "Profile for the container service master." + }, + "ManagedClusterAgentPoolProfileProperties": { + "properties": { + "count": { + "type": "integer", + "format": "int32", + "description": "Number of agents (VMs) to host docker containers. Allowed values must be in the range of 0 to 1000 (inclusive) for user pools and in the range of 1 to 1000 (inclusive) for system pools. The default value is 1." + }, + "vmSize": { + "type": "string", + "title": "The size of the agent pool VMs.", + "description": "VM size availability varies by region. If a node contains insufficient compute resources (memory, cpu, etc) pods might fail to run correctly. For more details on restricted VM sizes, see: https://docs.microsoft.com/azure/aks/quotas-skus-regions" + }, + "osDiskSizeGB": { + "$ref": "#/definitions/ContainerServiceOSDisk" + }, + "osDiskType": { + "$ref": "#/definitions/OSDiskType" + }, + "kubeletDiskType": { + "$ref": "#/definitions/KubeletDiskType" + }, + "vnetSubnetID": { + "type": "string", + "title": "The ID of the subnet which agent pool nodes and optionally pods will join on startup.", + "description": "If this is not specified, a VNET and subnet will be generated and used. If no podSubnetID is specified, this applies to nodes and pods, otherwise it applies to just nodes. This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}" + }, + "podSubnetID": { + "type": "string", + "title": "The ID of the subnet which pods will join when launched.", + "description": "If omitted, pod IPs are statically assigned on the node subnet (see vnetSubnetID for more details). This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}" + }, + "maxPods": { + "type": "integer", + "format": "int32", + "description": "The maximum number of pods that can run on a node." + }, + "osType": { + "$ref": "#/definitions/OSType" + }, + "osSKU": { + "$ref": "#/definitions/OSSKU" + }, + "maxCount": { + "type": "integer", + "format": "int32", + "description": "The maximum number of nodes for auto-scaling" + }, + "minCount": { + "type": "integer", + "format": "int32", + "description": "The minimum number of nodes for auto-scaling" + }, + "enableAutoScaling": { + "type": "boolean", + "description": "Whether to enable auto-scaler" + }, + "scaleDownMode": { + "$ref": "#/definitions/ScaleDownMode", + "title": "The scale down mode to use when scaling the Agent Pool.", + "description": "This also effects the cluster autoscaler behavior. If not specified, it defaults to Delete." + }, + "type": { + "$ref": "#/definitions/AgentPoolType" + }, + "mode": { + "$ref": "#/definitions/AgentPoolMode" + }, + "orchestratorVersion": { + "type": "string", + "title": "The version of Kubernetes running on the Agent Pool.", + "description": "As a best practice, you should upgrade all node pools in an AKS cluster to the same Kubernetes version. The node pool version must have the same major version as the control plane. The node pool minor version must be within two minor versions of the control plane version. The node pool version cannot be greater than the control plane version. For more information see [upgrading a node pool](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#upgrade-a-node-pool)." + }, + "nodeImageVersion": { + "readOnly": true, + "type": "string", + "description": "The version of node image" + }, + "upgradeSettings": { + "$ref": "#/definitions/AgentPoolUpgradeSettings", + "description": "Settings for upgrading the agentpool" + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The current deployment or provisioning state." + }, + "powerState": { + "readOnly": true, + "description": "Describes whether the Agent Pool is Running or Stopped", + "$ref": "#/definitions/PowerState" + }, + "availabilityZones": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of Availability zones to use for nodes. This can only be specified if the AgentPoolType property is 'VirtualMachineScaleSets'." + }, + "enableNodePublicIP": { + "type": "boolean", + "title": "Whether each node is allocated its own public IP.", + "description": "Some scenarios may require nodes in a node pool to receive their own dedicated public IP addresses. A common scenario is for gaming workloads, where a console needs to make a direct connection to a cloud virtual machine to minimize hops. For more information see [assigning a public IP per node](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#assign-a-public-ip-per-node-for-your-node-pools). The default is false." + }, + "nodePublicIPPrefixID": { + "type": "string", + "title": "The public IP prefix ID which VM nodes should use IPs from.", + "description": "This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}" + }, + "scaleSetPriority": { + "$ref": "#/definitions/ScaleSetPriority", + "description": "The Virtual Machine Scale Set priority. If not specified, the default is 'Regular'." + }, + "scaleSetEvictionPolicy": { + "$ref": "#/definitions/ScaleSetEvictionPolicy", + "title": "The Virtual Machine Scale Set eviction policy to use.", + "description": "This cannot be specified unless the scaleSetPriority is 'Spot'. If not specified, the default is 'Delete'." + }, + "spotMaxPrice": { + "$ref": "#/definitions/SpotMaxPrice", + "title": "The max price (in US Dollars) you are willing to pay for spot instances. Possible values are any decimal value greater than zero or -1 which indicates default price to be up-to on-demand.", + "description": "Possible values are any decimal value greater than zero or -1 which indicates the willingness to pay any on-demand price. For more details on spot pricing, see [spot VMs pricing](https://docs.microsoft.com/azure/virtual-machines/spot-vms#pricing)" + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The tags to be persisted on the agent pool virtual machine scale set." + }, + "nodeLabels": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The node labels to be persisted across all nodes in agent pool." + }, + "nodeTaints": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule." + }, + "proximityPlacementGroupID": { + "$ref": "#/definitions/ProximityPlacementGroupID", + "description": "The ID for Proximity Placement Group." + }, + "kubeletConfig": { + "$ref": "#/definitions/KubeletConfig", + "description": "The Kubelet configuration on the agent pool nodes." + }, + "linuxOSConfig": { + "$ref": "#/definitions/LinuxOSConfig", + "description": "The OS configuration of Linux agent nodes." + }, + "enableEncryptionAtHost": { + "type": "boolean", + "title": "Whether to enable host based OS and data drive encryption.", + "description": "This is only supported on certain VM sizes and in certain Azure regions. For more information, see: https://docs.microsoft.com/azure/aks/enable-host-encryption" + }, + "enableUltraSSD": { + "type": "boolean", + "description": "Whether to enable UltraSSD" + }, + "enableFIPS": { + "type": "boolean", + "title": "Whether to use a FIPS-enabled OS.", + "description": "See [Add a FIPS-enabled node pool](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#add-a-fips-enabled-node-pool-preview) for more details." + }, + "gpuInstanceProfile": { + "$ref": "#/definitions/GPUInstanceProfile", + "description": "GPUInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU." + } + }, + "description": "Properties for the container service agent pool profile." + }, + "ManagedClusterAgentPoolProfile": { + "allOf": [ + { + "$ref": "#/definitions/ManagedClusterAgentPoolProfileProperties" + }, + { + "properties": { + "name": { + "type": "string", + "title": "Unique name of the agent pool profile in the context of the subscription and resource group.", + "description": "Windows agent pool names must be 6 characters or less.", + "pattern": "^[a-z][a-z0-9]{0,11}$" + } + } + } + ], + "required": [ + "name" + ], + "description": "Profile for the container service agent pool." + }, + "AgentPoolType": { + "type": "string", + "enum": [ + "VirtualMachineScaleSets", + "AvailabilitySet" + ], + "x-ms-enum": { + "name": "AgentPoolType", + "modelAsString": true, + "values": [ + { + "value": "VirtualMachineScaleSets", + "description": "Create an Agent Pool backed by a Virtual Machine Scale Set." + }, + { + "value": "AvailabilitySet", + "description": "Use of this is strongly discouraged." + } + ] + }, + "description": "The type of Agent Pool." + }, + "AgentPoolMode": { + "type": "string", + "enum": [ + "System", + "User" + ], + "x-ms-enum": { + "name": "AgentPoolMode", + "modelAsString": true, + "values": [ + { + "value": "System", + "description": "System agent pools are primarily for hosting critical system pods such as CoreDNS and metrics-server. System agent pools osType must be Linux. System agent pools VM SKU must have at least 2vCPUs and 4GB of memory." + }, + { + "value": "User", + "description": "User agent pools are primarily for hosting your application pods." + } + ] + }, + "title": "The mode of an agent pool.", + "description": "A cluster must have at least one 'System' Agent Pool at all times. For additional information on agent pool restrictions and best practices, see: https://docs.microsoft.com/azure/aks/use-system-pools" + }, + "AgentPoolListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/AgentPool" + }, + "description": "The list of agent pools." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of agent pool results.", + "readOnly": true + } + }, + "description": "The response from the List Agent Pools operation." + }, + "AgentPoolUpgradeSettings": { + "properties": { + "maxSurge": { + "type": "string", + "title": "The maximum number or percentage of nodes that are surged during upgrade.", + "description": "This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified, the default is 1. For more information, including best practices, see: https://docs.microsoft.com/azure/aks/upgrade-cluster#customize-node-surge-upgrade" + } + }, + "description": "Settings for upgrading an agentpool" + }, + "AgentPool": { + "allOf": [ + { + "$ref": "#/definitions/SubResource" + }, + { + "properties": { + "properties": { + "description": "Properties of an agent pool.", + "$ref": "#/definitions/ManagedClusterAgentPoolProfileProperties", + "x-ms-client-flatten": true + } + } + } + ], + "description": "Agent Pool." + }, + "ManagedClusterWindowsProfile": { + "properties": { + "adminUsername": { + "type": "string", + "description": "Specifies the name of the administrator account.

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

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

**Minimum-length:** 1 character

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

**Minimum-length:** 8 characters

**Max-length:** 123 characters

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

**Disallowed values:** \"abc@123\", \"P@$$w0rd\", \"P@ssw0rd\", \"P@ssword123\", \"Pa$$word\", \"pass@word1\", \"Password!\", \"Password1\", \"Password22\", \"iloveyou!\"" + }, + "licenseType": { + "type": "string", + "enum": [ + "None", + "Windows_Server" + ], + "x-ms-enum": { + "name": "licenseType", + "modelAsString": true, + "values": [ + { + "value": "None", + "description": "No additional licensing is applied." + }, + { + "value": "Windows_Server", + "description": "Enables Azure Hybrid User Benefits for Windows VMs." + } + ] + }, + "description": "The license type to use for Windows VMs. See [Azure Hybrid User Benefits](https://azure.microsoft.com/pricing/hybrid-benefit/faq/) for more details." + }, + "enableCSIProxy": { + "type": "boolean", + "title": "Whether to enable CSI proxy.", + "description": "For more details on CSI proxy, see the [CSI proxy GitHub repo](https://github.com/kubernetes-csi/csi-proxy)." + } + }, + "required": [ + "adminUsername" + ], + "description": "Profile for Windows VMs in the managed cluster." + }, + "ContainerServiceLinuxProfile": { + "properties": { + "adminUsername": { + "type": "string", + "description": "The administrator username to use for Linux VMs.", + "pattern": "^[A-Za-z][-A-Za-z0-9_]*$" + }, + "ssh": { + "$ref": "#/definitions/ContainerServiceSshConfiguration", + "description": "The SSH configuration for Linux-based VMs running on Azure." + } + }, + "required": [ + "adminUsername", + "ssh" + ], + "description": "Profile for Linux VMs in the container service cluster." + }, + "ContainerServiceNetworkProfile": { + "properties": { + "networkPlugin": { + "type": "string", + "enum": [ + "azure", + "kubenet" + ], + "default": "kubenet", + "x-ms-enum": { + "name": "NetworkPlugin", + "modelAsString": true, + "values": [ + { + "value": "azure", + "description": "Use the Azure CNI network plugin. See [Azure CNI (advanced) networking](https://docs.microsoft.com/azure/aks/concepts-network#azure-cni-advanced-networking) for more information." + }, + { + "value": "kubenet", + "description": "Use the Kubenet network plugin. See [Kubenet (basic) networking](https://docs.microsoft.com/azure/aks/concepts-network#kubenet-basic-networking) for more information." + } + ] + }, + "description": "Network plugin used for building the Kubernetes network." + }, + "networkPolicy": { + "type": "string", + "enum": [ + "calico", + "azure" + ], + "x-ms-enum": { + "name": "NetworkPolicy", + "modelAsString": true, + "values": [ + { + "value": "calico", + "description": "Use Calico network policies. See [differences between Azure and Calico policies](https://docs.microsoft.com/azure/aks/use-network-policies#differences-between-azure-and-calico-policies-and-their-capabilities) for more information." + }, + { + "value": "azure", + "description": "Use Azure network policies. See [differences between Azure and Calico policies](https://docs.microsoft.com/azure/aks/use-network-policies#differences-between-azure-and-calico-policies-and-their-capabilities) for more information." + } + ] + }, + "description": "Network policy used for building the Kubernetes network." + }, + "networkMode": { + "type": "string", + "enum": [ + "transparent", + "bridge" + ], + "x-ms-enum": { + "name": "networkMode", + "modelAsString": true, + "values": [ + { + "value": "transparent", + "description": "No bridge is created. Intra-VM Pod to Pod communication is through IP routes created by Azure CNI. See [Transparent Mode](https://docs.microsoft.com/azure/aks/faq#transparent-mode) for more information." + }, + { + "value": "bridge", + "description": "This is no longer supported" + } + ] + }, + "title": "The network mode Azure CNI is configured with.", + "description": "This cannot be specified if networkPlugin is anything other than 'azure'." + }, + "podCidr": { + "type": "string", + "pattern": "^([0-9]{1,3}\\.){3}[0-9]{1,3}(\\/([0-9]|[1-2][0-9]|3[0-2]))?$", + "default": "10.244.0.0/16", + "description": "A CIDR notation IP range from which to assign pod IPs when kubenet is used." + }, + "serviceCidr": { + "type": "string", + "pattern": "^([0-9]{1,3}\\.){3}[0-9]{1,3}(\\/([0-9]|[1-2][0-9]|3[0-2]))?$", + "default": "10.0.0.0/16", + "description": "A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges." + }, + "dnsServiceIP": { + "type": "string", + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "default": "10.0.0.10", + "description": "An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr." + }, + "dockerBridgeCidr": { + "type": "string", + "pattern": "^([0-9]{1,3}\\.){3}[0-9]{1,3}(\\/([0-9]|[1-2][0-9]|3[0-2]))?$", + "default": "172.17.0.1/16", + "description": "A CIDR notation IP range assigned to the Docker bridge network. It must not overlap with any Subnet IP ranges or the Kubernetes service address range." + }, + "outboundType": { + "type": "string", + "enum": [ + "loadBalancer", + "userDefinedRouting", + "managedNATGateway", + "userAssignedNATGateway" + ], + "x-ms-enum": { + "name": "outboundType", + "modelAsString": true, + "values": [ + { + "value": "loadBalancer", + "description": "The load balancer is used for egress through an AKS assigned public IP. This supports Kubernetes services of type 'loadBalancer'. For more information see [outbound type loadbalancer](https://docs.microsoft.com/azure/aks/egress-outboundtype#outbound-type-of-loadbalancer)." + }, + { + "value": "userDefinedRouting", + "description": "Egress paths must be defined by the user. This is an advanced scenario and requires proper network configuration. For more information see [outbound type userDefinedRouting](https://docs.microsoft.com/azure/aks/egress-outboundtype#outbound-type-of-userdefinedrouting)." + }, + { + "value": "managedNATGateway", + "description": "The AKS-managed NAT gateway is used for egress." + }, + { + "value": "userAssignedNATGateway", + "description": "The user-assigned NAT gateway associated to the cluster subnet is used for egress. This is an advanced scenario and requires proper network configuration." + } + ] + }, + "default": "loadBalancer", + "title": "The outbound (egress) routing method.", + "description": "This can only be set at cluster creation time and cannot be changed later. For more information see [egress outbound type](https://docs.microsoft.com/azure/aks/egress-outboundtype)." + }, + "loadBalancerSku": { + "type": "string", + "enum": [ + "standard", + "basic" + ], + "x-ms-enum": { + "name": "loadBalancerSku", + "modelAsString": true, + "values": [ + { + "value": "standard", + "description": "Use a a standard Load Balancer. This is the recommended Load Balancer SKU. For more information about on working with the load balancer in the managed cluster, see the [standard Load Balancer](https://docs.microsoft.com/azure/aks/load-balancer-standard) article." + }, + { + "value": "basic", + "description": "Use a basic Load Balancer with limited functionality." + } + ] + }, + "title": "The load balancer sku for the managed cluster.", + "description": "The default is 'standard'. See [Azure Load Balancer SKUs](https://docs.microsoft.com/azure/load-balancer/skus) for more information about the differences between load balancer SKUs." + }, + "loadBalancerProfile": { + "$ref": "#/definitions/ManagedClusterLoadBalancerProfile", + "description": "Profile of the cluster load balancer." + }, + "natGatewayProfile": { + "$ref": "#/definitions/ManagedClusterNATGatewayProfile", + "description": "Profile of the cluster NAT gateway." + } + }, + "description": "Profile of network configuration." + }, + "MaintenanceConfigurationListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/MaintenanceConfiguration" + }, + "description": "The list of maintenance configurations." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of maintenance configuration results.", + "readOnly": true + } + }, + "description": "The response from the List maintenance configurations operation." + }, + "SystemData": { + "description": "Metadata pertaining to creation and last modification of the resource.", + "type": "object", + "readOnly": true, + "properties": { + "createdBy": { + "type": "string", + "description": "The identity that created the resource." + }, + "createdByType": { + "type": "string", + "description": "The type of identity that created the resource.", + "enum": [ + "User", + "Application", + "ManagedIdentity", + "Key" + ], + "x-ms-enum": { + "name": "createdByType", + "modelAsString": true + } + }, + "createdAt": { + "type": "string", + "format": "date-time", + "description": "The UTC timestamp of resource creation." + }, + "lastModifiedBy": { + "type": "string", + "description": "The identity that last modified the resource." + }, + "lastModifiedByType": { + "type": "string", + "description": "The type of identity that last modified the resource.", + "enum": [ + "User", + "Application", + "ManagedIdentity", + "Key" + ], + "x-ms-enum": { + "name": "createdByType", + "modelAsString": true + } + }, + "lastModifiedAt": { + "type": "string", + "format": "date-time", + "description": "The type of identity that last modified the resource." + } + } + }, + "MaintenanceConfiguration": { + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ], + "properties": { + "systemData": { + "$ref": "#/definitions/SystemData", + "readOnly": true, + "description": "The system metadata relating to this resource." + }, + "properties": { + "description": "Properties of a default maintenance configuration.", + "$ref": "#/definitions/MaintenanceConfigurationProperties", + "x-ms-client-flatten": true + } + }, + "title": "Planned maintenance configuration, used to configure when updates can be deployed to a Managed Cluster.", + "description": "See [planned maintenance](https://docs.microsoft.com/azure/aks/planned-maintenance) for more information about planned maintenance." + }, + "MaintenanceConfigurationProperties": { + "properties": { + "timeInWeek": { + "type": "array", + "items": { + "$ref": "#/definitions/TimeInWeek" + }, + "title": "Time slots during the week when planned maintenance is allowed to proceed.", + "description": "If two array entries specify the same day of the week, the applied configuration is the union of times in both entries." + }, + "notAllowedTime": { + "type": "array", + "items": { + "$ref": "#/definitions/TimeSpan" + }, + "description": "Time slots on which upgrade is not allowed." + } + }, + "description": "Properties used to configure planned maintenance for a Managed Cluster." + }, + "TimeInWeek": { + "properties": { + "day": { + "$ref": "#/definitions/WeekDay", + "description": "The day of the week." + }, + "hourSlots": { + "type": "array", + "items": { + "$ref": "#/definitions/HourInDay" + }, + "title": "A list of hours in the day used to identify a time range.", + "description": "Each integer hour represents a time range beginning at 0m after the hour ending at the next hour (non-inclusive). 0 corresponds to 00:00 UTC, 23 corresponds to 23:00 UTC. Specifying [0, 1] means the 00:00 - 02:00 UTC time range." + } + }, + "description": "Time in a week." + }, + "WeekDay": { + "type": "string", + "enum": [ + "Sunday", + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday", + "Saturday" + ], + "x-ms-enum": { + "name": "WeekDay", + "modelAsString": true + }, + "description": "The weekday enum." + }, + "HourInDay": { + "type": "integer", + "format": "int32", + "maximum": 23, + "minimum": 0, + "description": "Hour in a day." + }, + "TimeSpan": { + "properties": { + "start": { + "type": "string", + "format": "date-time", + "description": "The start of a time span" + }, + "end": { + "type": "string", + "format": "date-time", + "description": "The end of a time span" + } + }, + "title": "A time range.", + "description": "For example, between 2021-05-25T13:00:00Z and 2021-05-25T14:00:00Z." + }, + "RunCommandRequest": { + "properties": { + "command": { + "type": "string", + "description": "The command to run." + }, + "context": { + "type": "string", + "description": "A base64 encoded zip file containing the files required by the command." + }, + "clusterToken": { + "type": "string", + "description": "AuthToken issued for AKS AAD Server App." + } + }, + "description": "A run command request", + "required": [ + "command" + ] + }, + "RunCommandResult": { + "properties": { + "id": { + "type": "string", + "description": "The command id.", + "readOnly": true + }, + "properties": { + "description": "Properties of command result.", + "$ref": "#/definitions/CommandResultProperties", + "x-ms-client-flatten": true + } + }, + "description": "run command result." + }, + "CommandResultProperties": { + "properties": { + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "provisioning State" + }, + "exitCode": { + "type": "integer", + "format": "int32", + "readOnly": true, + "description": "The exit code of the command" + }, + "startedAt": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "The time when the command started." + }, + "finishedAt": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "The time when the command finished." + }, + "logs": { + "type": "string", + "readOnly": true, + "description": "The command output." + }, + "reason": { + "type": "string", + "readOnly": true, + "description": "An explanation of why provisioningState is set to failed (if so)." + } + }, + "description": "The results of a run command" + }, + "ManagedClusterNATGatewayProfile": { + "type": "object", + "properties": { + "managedOutboundIPProfile": { + "$ref": "#/definitions/ManagedClusterManagedOutboundIPProfile", + "description": "Profile of the managed outbound IP resources of the cluster NAT gateway." + }, + "effectiveOutboundIPs": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceReference" + }, + "description": "The effective outbound IP resources of the cluster NAT gateway." + }, + "idleTimeoutInMinutes": { + "type": "integer", + "format": "int32", + "maximum": 120, + "minimum": 4, + "description": "Desired outbound flow idle timeout in minutes. Allowed values are in the range of 4 to 120 (inclusive). The default value is 4 minutes.", + "default": 4 + } + }, + "description": "Profile of the managed cluster NAT gateway." + }, + "ManagedClusterManagedOutboundIPProfile": { + "type": "object", + "properties": { + "count": { + "type": "integer", + "format": "int32", + "maximum": 16, + "minimum": 1, + "description": "The desired number of outbound IPs created/managed by Azure. Allowed values must be in the range of 1 to 16 (inclusive). The default value is 1. ", + "default": 1 + } + }, + "description": "Profile of the managed outbound IP resources of the managed cluster." + }, + "ManagedClusterLoadBalancerProfile": { + "properties": { + "managedOutboundIPs": { + "properties": { + "count": { + "type": "integer", + "format": "int32", + "maximum": 100, + "minimum": 1, + "description": "The desired number of outbound IPs created/managed by Azure for the cluster load balancer. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 1. ", + "default": 1 + } + }, + "description": "Desired managed outbound IPs for the cluster load balancer." + }, + "outboundIPPrefixes": { + "properties": { + "publicIPPrefixes": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceReference" + }, + "description": "A list of public IP prefix resources." + } + }, + "description": "Desired outbound IP Prefix resources for the cluster load balancer." + }, + "outboundIPs": { + "properties": { + "publicIPs": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceReference" + }, + "description": "A list of public IP resources." + } + }, + "description": "Desired outbound IP resources for the cluster load balancer." + }, + "effectiveOutboundIPs": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceReference" + }, + "description": "The effective outbound IP resources of the cluster load balancer." + }, + "allocatedOutboundPorts": { + "type": "integer", + "format": "int32", + "maximum": 64000, + "minimum": 0, + "description": "The desired number of allocated SNAT ports per VM. Allowed values are in the range of 0 to 64000 (inclusive). The default value is 0 which results in Azure dynamically allocating ports.", + "default": 0 + }, + "idleTimeoutInMinutes": { + "type": "integer", + "format": "int32", + "maximum": 120, + "minimum": 4, + "description": "Desired outbound flow idle timeout in minutes. Allowed values are in the range of 4 to 120 (inclusive). The default value is 30 minutes.", + "default": 30 + } + }, + "description": "Profile of the managed cluster load balancer." + }, + "ResourceReference": { + "properties": { + "id": { + "type": "string", + "description": "The fully qualified Azure resource id." + } + }, + "description": "A reference to an Azure resource." + }, + "ContainerServiceSshConfiguration": { + "properties": { + "publicKeys": { + "type": "array", + "items": { + "$ref": "#/definitions/ContainerServiceSshPublicKey" + }, + "description": "The list of SSH public keys used to authenticate with Linux-based VMs. A maximum of 1 key may be specified." + } + }, + "description": "SSH configuration for Linux-based VMs running on Azure.", + "required": [ + "publicKeys" + ] + }, + "ContainerServiceSshPublicKey": { + "properties": { + "keyData": { + "type": "string", + "description": "Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers." + } + }, + "required": [ + "keyData" + ], + "description": "Contains information about SSH certificate public key data." + }, + "ContainerServiceDiagnosticsProfile": { + "properties": { + "vmDiagnostics": { + "$ref": "#/definitions/ContainerServiceVMDiagnostics", + "description": "Profile for diagnostics on the container service VMs." + } + }, + "description": "Profile for diagnostics on the container service cluster.", + "required": [ + "vmDiagnostics" + ] + }, + "ContainerServiceVMDiagnostics": { + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether the VM diagnostic agent is provisioned on the VM." + }, + "storageUri": { + "readOnly": true, + "type": "string", + "description": "The URI of the storage account where diagnostics are stored." + } + }, + "description": "Profile for diagnostics on the container service VMs.", + "required": [ + "enabled" + ] + }, + "ManagedClusterListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ManagedCluster" + }, + "description": "The list of managed clusters." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of managed cluster results.", + "readOnly": true + } + }, + "description": "The response from the List Managed Clusters operation." + }, + "ManagedCluster": { + "properties": { + "sku": { + "$ref": "#/definitions/ManagedClusterSKU", + "description": "The managed cluster SKU." + }, + "extendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "The extended location of the Virtual Machine." + }, + "identity": { + "$ref": "#/definitions/ManagedClusterIdentity", + "description": "The identity of the managed cluster, if configured." + }, + "properties": { + "description": "Properties of a managed cluster.", + "$ref": "#/definitions/ManagedClusterProperties", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "Managed cluster." + }, + "ManagedClusterProperties": { + "properties": { + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The current provisioning state." + }, + "powerState": { + "$ref": "#/definitions/PowerState", + "description": "The Power State of the cluster.", + "readOnly": true + }, + "maxAgentPools": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "The max number of agent pools for the managed cluster." + }, + "kubernetesVersion": { + "type": "string", + "title": "The version of Kubernetes the Managed Cluster is running.", + "description": "When you upgrade a supported AKS cluster, Kubernetes minor versions cannot be skipped. All upgrades must be performed sequentially by major version number. For example, upgrades between 1.14.x -> 1.15.x or 1.15.x -> 1.16.x are allowed, however 1.14.x -> 1.16.x is not allowed. See [upgrading an AKS cluster](https://docs.microsoft.com/azure/aks/upgrade-cluster) for more details." + }, + "dnsPrefix": { + "type": "string", + "title": "The DNS prefix of the Managed Cluster.", + "description": "This cannot be updated once the Managed Cluster has been created." + }, + "fqdnSubdomain": { + "type": "string", + "title": "The FQDN subdomain of the private cluster with custom private dns zone.", + "description": "This cannot be updated once the Managed Cluster has been created." + }, + "fqdn": { + "readOnly": true, + "type": "string", + "description": "The FQDN of the master pool." + }, + "privateFQDN": { + "readOnly": true, + "type": "string", + "description": "The FQDN of private cluster." + }, + "azurePortalFQDN": { + "readOnly": true, + "type": "string", + "title": "The special FQDN used by the Azure Portal to access the Managed Cluster. This FQDN is for use only by the Azure Portal and should not be used by other clients.", + "description": "The Azure Portal requires certain Cross-Origin Resource Sharing (CORS) headers to be sent in some responses, which Kubernetes APIServer doesn't handle by default. This special FQDN supports CORS, allowing the Azure Portal to function properly." + }, + "agentPoolProfiles": { + "type": "array", + "items": { + "$ref": "#/definitions/ManagedClusterAgentPoolProfile" + }, + "description": "The agent pool properties." + }, + "linuxProfile": { + "$ref": "#/definitions/ContainerServiceLinuxProfile", + "description": "The profile for Linux VMs in the Managed Cluster." + }, + "windowsProfile": { + "$ref": "#/definitions/ManagedClusterWindowsProfile", + "description": "The profile for Windows VMs in the Managed Cluster." + }, + "servicePrincipalProfile": { + "$ref": "#/definitions/ManagedClusterServicePrincipalProfile", + "description": "Information about a service principal identity for the cluster to use for manipulating Azure APIs." + }, + "addonProfiles": { + "additionalProperties": { + "$ref": "#/definitions/ManagedClusterAddonProfile" + }, + "description": "The profile of managed cluster add-on." + }, + "podIdentityProfile": { + "$ref": "#/definitions/ManagedClusterPodIdentityProfile", + "title": "The pod identity profile of the Managed Cluster.", + "description": "See [use AAD pod identity](https://docs.microsoft.com/azure/aks/use-azure-ad-pod-identity) for more details on AAD pod identity integration." + }, + "nodeResourceGroup": { + "type": "string", + "description": "The name of the resource group containing agent pool nodes." + }, + "enableRBAC": { + "type": "boolean", + "description": "Whether to enable Kubernetes Role-Based Access Control." + }, + "enablePodSecurityPolicy": { + "type": "boolean", + "description": "(DEPRECATING) Whether to enable Kubernetes pod security policy (preview). This feature is set for removal on October 15th, 2020. Learn more at aka.ms/aks/azpodpolicy." + }, + "networkProfile": { + "$ref": "#/definitions/ContainerServiceNetworkProfile", + "description": "The network configuration profile." + }, + "aadProfile": { + "$ref": "#/definitions/ManagedClusterAADProfile", + "description": "The Azure Active Directory configuration." + }, + "autoUpgradeProfile": { + "$ref": "#/definitions/ManagedClusterAutoUpgradeProfile", + "description": "The auto upgrade configuration." + }, + "autoScalerProfile": { + "type": "object", + "properties": { + "balance-similar-node-groups": { + "type": "string", + "title": "Detects similar node pools and balances the number of nodes between them.", + "description": "Valid values are 'true' and 'false'" + }, + "expander": { + "type": "string", + "enum": [ + "least-waste", + "most-pods", + "priority", + "random" + ], + "x-ms-enum": { + "name": "expander", + "modelAsString": true, + "values": [ + { + "value": "least-waste", + "description": "Selects the node group that will have the least idle CPU (if tied, unused memory) after scale-up. This is useful when you have different classes of nodes, for example, high CPU or high memory nodes, and only want to expand those when there are pending pods that need a lot of those resources." + }, + { + "value": "most-pods", + "description": "Selects the node group that would be able to schedule the most pods when scaling up. This is useful when you are using nodeSelector to make sure certain pods land on certain nodes. Note that this won't cause the autoscaler to select bigger nodes vs. smaller, as it can add multiple smaller nodes at once." + }, + { + "value": "priority", + "description": "Selects the node group that has the highest priority assigned by the user. It's configuration is described in more details [here](https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/expander/priority/readme.md)." + }, + { + "value": "random", + "description": "Used when you don't have a particular need for the node groups to scale differently." + } + ] + }, + "title": "The expander to use when scaling up", + "description": "If not specified, the default is 'random'. See [expanders](https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/FAQ.md#what-are-expanders) for more information." + }, + "max-empty-bulk-delete": { + "type": "string", + "title": "The maximum number of empty nodes that can be deleted at the same time. This must be a positive integer.", + "description": "The default is 10." + }, + "max-graceful-termination-sec": { + "type": "string", + "title": "The maximum number of seconds the cluster autoscaler waits for pod termination when trying to scale down a node.", + "description": "The default is 600." + }, + "max-node-provision-time": { + "type": "string", + "title": "The maximum time the autoscaler waits for a node to be provisioned.", + "description": "The default is '15m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported." + }, + "max-total-unready-percentage": { + "type": "string", + "title": "The maximum percentage of unready nodes in the cluster. After this percentage is exceeded, cluster autoscaler halts operations.", + "description": "The default is 45. The maximum is 100 and the minimum is 0." + }, + "new-pod-scale-up-delay": { + "type": "string", + "title": "Ignore unscheduled pods before they're a certain age.", + "description": "For scenarios like burst/batch scale where you don't want CA to act before the kubernetes scheduler could schedule all the pods, you can tell CA to ignore unscheduled pods before they're a certain age. The default is '0s'. Values must be an integer followed by a unit ('s' for seconds, 'm' for minutes, 'h' for hours, etc)." + }, + "ok-total-unready-count": { + "type": "string", + "title": "The number of allowed unready nodes, irrespective of max-total-unready-percentage.", + "description": "This must be an integer. The default is 3." + }, + "scan-interval": { + "type": "string", + "title": "How often cluster is reevaluated for scale up or down.", + "description": "The default is '10'. Values must be an integer number of seconds." + }, + "scale-down-delay-after-add": { + "type": "string", + "title": "How long after scale up that scale down evaluation resumes", + "description": "The default is '10m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported." + }, + "scale-down-delay-after-delete": { + "type": "string", + "title": "How long after node deletion that scale down evaluation resumes.", + "description": "The default is the scan-interval. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported." + }, + "scale-down-delay-after-failure": { + "type": "string", + "title": "How long after scale down failure that scale down evaluation resumes.", + "description": "The default is '3m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported." + }, + "scale-down-unneeded-time": { + "type": "string", + "title": "How long a node should be unneeded before it is eligible for scale down.", + "description": "The default is '10m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported." + }, + "scale-down-unready-time": { + "type": "string", + "title": "How long an unready node should be unneeded before it is eligible for scale down", + "description": "The default is '20m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported." + }, + "scale-down-utilization-threshold": { + "type": "string", + "title": "Node utilization level, defined as sum of requested resources divided by capacity, below which a node can be considered for scale down.", + "description": "The default is '0.5'." + }, + "skip-nodes-with-local-storage": { + "type": "string", + "title": "If cluster autoscaler will skip deleting nodes with pods with local storage, for example, EmptyDir or HostPath.", + "description": "The default is true." + }, + "skip-nodes-with-system-pods": { + "type": "string", + "title": "If cluster autoscaler will skip deleting nodes with pods from kube-system (except for DaemonSet or mirror pods)", + "description": "The default is true." + } + }, + "description": "Parameters to be applied to the cluster-autoscaler when enabled" + }, + "apiServerAccessProfile": { + "$ref": "#/definitions/ManagedClusterAPIServerAccessProfile", + "description": "The access profile for managed cluster API server." + }, + "diskEncryptionSetID": { + "type": "string", + "title": "The Resource ID of the disk encryption set to use for enabling encryption at rest.", + "description": "This is of the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{encryptionSetName}'" + }, + "identityProfile": { + "additionalProperties": { + "$ref": "#/definitions/UserAssignedIdentity" + }, + "description": "Identities associated with the cluster." + }, + "privateLinkResources": { + "type": "array", + "items": { + "$ref": "#/definitions/PrivateLinkResource" + }, + "description": "Private link resources associated with the cluster." + }, + "disableLocalAccounts": { + "type": "boolean", + "title": "If local accounts should be disabled on the Managed Cluster.", + "description": "If set to true, getting static credentials will be disabled for this cluster. This must only be used on Managed Clusters that are AAD enabled. For more details see [disable local accounts](https://docs.microsoft.com/azure/aks/managed-aad#disable-local-accounts-preview)." + }, + "httpProxyConfig": { + "$ref": "#/definitions/ManagedClusterHTTPProxyConfig", + "description": "Configurations for provisioning the cluster with HTTP proxy servers." + }, + "securityProfile": { + "$ref": "#/definitions/ManagedClusterSecurityProfile", + "description": "Security profile for the managed cluster." + } + }, + "description": "Properties of the managed cluster." + }, + "PowerState": { + "description": "Describes the Power State of the cluster", + "properties": { + "code": { + "type": "string", + "description": "Tells whether the cluster is Running or Stopped", + "enum": [ + "Running", + "Stopped" + ], + "x-ms-enum": { + "name": "code", + "modelAsString": true, + "values": [ + { + "value": "Running", + "description": "The cluster is running." + }, + { + "value": "Stopped", + "description": "The cluster is stopped." + } + ] + } + } + } + }, + "ManagedClusterAPIServerAccessProfile": { + "properties": { + "authorizedIPRanges": { + "type": "array", + "items": { + "type": "string" + }, + "title": "The IP ranges authorized to access the Kubernetes API server.", + "description": "IP ranges are specified in CIDR format, e.g. 137.117.106.88/29. This feature is not compatible with clusters that use Public IP Per Node, or clusters that are using a Basic Load Balancer. For more information see [API server authorized IP ranges](https://docs.microsoft.com/azure/aks/api-server-authorized-ip-ranges)." + }, + "enablePrivateCluster": { + "type": "boolean", + "title": "Whether to create the cluster as a private cluster or not.", + "description": "For more details, see [Creating a private AKS cluster](https://docs.microsoft.com/azure/aks/private-clusters)." + }, + "privateDNSZone": { + "type": "string", + "title": "The private DNS zone mode for the cluster.", + "description": "The default is System. For more details see [configure private DNS zone](https://docs.microsoft.com/azure/aks/private-clusters#configure-private-dns-zone). Allowed values are 'system' and 'none'." + }, + "enablePrivateClusterPublicFQDN": { + "type": "boolean", + "description": "Whether to create additional public FQDN for private cluster or not." + } + }, + "description": "Access profile for managed cluster API server." + }, + "ManagedClusterIdentity": { + "properties": { + "principalId": { + "readOnly": true, + "type": "string", + "description": "The principal id of the system assigned identity which is used by master components." + }, + "tenantId": { + "readOnly": true, + "type": "string", + "description": "The tenant id of the system assigned identity which is used by master components." + }, + "type": { + "type": "string", + "title": "The type of identity used for the managed cluster.", + "description": "For more information see [use managed identities in AKS](https://docs.microsoft.com/azure/aks/use-managed-identity).", + "enum": [ + "SystemAssigned", + "UserAssigned", + "None" + ], + "x-ms-enum": { + "name": "ResourceIdentityType", + "modelAsString": false, + "values": [ + { + "value": "SystemAssigned", + "description": "Use an implicitly created system assigned managed identity to manage cluster resources. Master components in the control plane such as kube-controller-manager will use the system assigned managed identity to manipulate Azure resources." + }, + { + "value": "UserAssigned", + "description": "Use a user-specified identity to manage cluster resources. Master components in the control plane such as kube-controller-manager will use the specified user assigned managed identity to manipulate Azure resources." + }, + { + "value": "None", + "description": "Do not use a managed identity for the Managed Cluster, service principal will be used instead." + } + ] + } + }, + "userAssignedIdentities": { + "type": "object", + "additionalProperties": { + "type": "object", + "x-ms-client-name": "ManagedServiceIdentityUserAssignedIdentitiesValue", + "properties": { + "principalId": { + "readOnly": true, + "type": "string", + "description": "The principal id of user assigned identity." + }, + "clientId": { + "readOnly": true, + "type": "string", + "description": "The client id of user assigned identity." + } + } + }, + "title": "The user identity associated with the managed cluster. This identity will be used in control plane. Only one user assigned identity is allowed.", + "description": "The keys must be ARM resource IDs in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'." + } + }, + "description": "Identity for the managed cluster." + }, + "UserAssignedIdentity": { + "properties": { + "resourceId": { + "type": "string", + "description": "The resource ID of the user assigned identity." + }, + "clientId": { + "type": "string", + "description": "The client ID of the user assigned identity." + }, + "objectId": { + "type": "string", + "description": "The object ID of the user assigned identity." + } + }, + "description": "Details about a user assigned identity." + }, + "ManagedClusterAccessProfile": { + "allOf": [ + { + "$ref": "#/definitions/Resource" + }, + { + "properties": { + "properties": { + "description": "AccessProfile of a managed cluster.", + "$ref": "#/definitions/AccessProfile", + "x-ms-client-flatten": true + } + } + } + ], + "description": "Managed cluster Access Profile.", + "x-ms-azure-resource": false + }, + "AccessProfile": { + "type": "object", + "properties": { + "kubeConfig": { + "type": "string", + "format": "byte", + "description": "Base64-encoded Kubernetes configuration file." + } + }, + "description": "Profile for enabling a user to access a managed cluster." + }, + "ManagedClusterPoolUpgradeProfile": { + "properties": { + "kubernetesVersion": { + "type": "string", + "description": "The Kubernetes version (major.minor.patch)." + }, + "name": { + "type": "string", + "description": "The Agent Pool name." + }, + "osType": { + "$ref": "#/definitions/OSType" + }, + "upgrades": { + "type": "array", + "items": { + "type": "object", + "properties": { + "kubernetesVersion": { + "type": "string", + "description": "The Kubernetes version (major.minor.patch)." + }, + "isPreview": { + "type": "boolean", + "description": "Whether the Kubernetes version is currently in preview." + } + } + }, + "description": "List of orchestrator types and versions available for upgrade." + } + }, + "required": [ + "kubernetesVersion", + "osType" + ], + "description": "The list of available upgrade versions." + }, + "ManagedClusterUpgradeProfileProperties": { + "properties": { + "controlPlaneProfile": { + "$ref": "#/definitions/ManagedClusterPoolUpgradeProfile", + "description": "The list of available upgrade versions for the control plane." + }, + "agentPoolProfiles": { + "type": "array", + "items": { + "$ref": "#/definitions/ManagedClusterPoolUpgradeProfile" + }, + "description": "The list of available upgrade versions for agent pools." + } + }, + "required": [ + "controlPlaneProfile", + "agentPoolProfiles" + ], + "description": "Control plane and agent pool upgrade profiles." + }, + "ManagedClusterAutoUpgradeProfile": { + "properties": { + "upgradeChannel": { + "type": "string", + "enum": [ + "rapid", + "stable", + "patch", + "node-image", + "none" + ], + "x-ms-enum": { + "name": "upgradeChannel", + "modelAsString": true, + "values": [ + { + "value": "rapid", + "description": "Automatically upgrade the cluster to the latest supported patch release on the latest supported minor version. In cases where the cluster is at a version of Kubernetes that is at an N-2 minor version where N is the latest supported minor version, the cluster first upgrades to the latest supported patch version on N-1 minor version. For example, if a cluster is running version 1.17.7 and versions 1.17.9, 1.18.4, 1.18.6, and 1.19.1 are available, your cluster first is upgraded to 1.18.6, then is upgraded to 1.19.1." + }, + { + "value": "stable", + "description": "Automatically upgrade the cluster to the latest supported patch release on minor version N-1, where N is the latest supported minor version. For example, if a cluster is running version 1.17.7 and versions 1.17.9, 1.18.4, 1.18.6, and 1.19.1 are available, your cluster is upgraded to 1.18.6." + }, + { + "value": "patch", + "description": "Automatically upgrade the cluster to the latest supported patch version when it becomes available while keeping the minor version the same. For example, if a cluster is running version 1.17.7 and versions 1.17.9, 1.18.4, 1.18.6, and 1.19.1 are available, your cluster is upgraded to 1.17.9." + }, + { + "value": "node-image", + "description": "Automatically upgrade the node image to the latest version available. Microsoft provides patches and new images for image nodes frequently (usually weekly), but your running nodes won't get the new images unless you do a node image upgrade. Turning on the node-image channel will automatically update your node images whenever a new version is available." + }, + { + "value": "none", + "description": "Disables auto-upgrades and keeps the cluster at its current version of Kubernetes." + } + ] + }, + "title": "The upgrade channel for auto upgrade. The default is 'none'.", + "description": "For more information see [setting the AKS cluster auto-upgrade channel](https://docs.microsoft.com/azure/aks/upgrade-cluster#set-auto-upgrade-channel)." + } + }, + "description": "Auto upgrade profile for a managed cluster." + }, + "ManagedClusterAADProfile": { + "properties": { + "managed": { + "type": "boolean", + "description": "Whether to enable managed AAD." + }, + "enableAzureRBAC": { + "type": "boolean", + "description": "Whether to enable Azure RBAC for Kubernetes authorization." + }, + "adminGroupObjectIDs": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of AAD group object IDs that will have admin role of the cluster." + }, + "clientAppID": { + "type": "string", + "description": "The client AAD application ID." + }, + "serverAppID": { + "type": "string", + "description": "The server AAD application ID." + }, + "serverAppSecret": { + "type": "string", + "description": "The server AAD application secret." + }, + "tenantID": { + "type": "string", + "description": "The AAD tenant ID to use for authentication. If not specified, will use the tenant of the deployment subscription." + } + }, + "title": "AADProfile specifies attributes for Azure Active Directory integration.", + "description": "For more details see [managed AAD on AKS](https://docs.microsoft.com/azure/aks/managed-aad)." + }, + "ManagedClusterAddonProfile": { + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether the add-on is enabled or not." + }, + "config": { + "additionalProperties": { + "type": "string" + }, + "description": "Key-value pairs for configuring an add-on." + }, + "identity": { + "readOnly": true, + "description": "Information of user assigned identity used by this add-on.", + "allOf": [ + { + "$ref": "#/definitions/UserAssignedIdentity" + } + ] + } + }, + "required": [ + "enabled" + ], + "description": "A Kubernetes add-on profile for a managed cluster." + }, + "ManagedClusterPodIdentity": { + "properties": { + "name": { + "type": "string", + "description": "The name of the pod identity." + }, + "namespace": { + "type": "string", + "description": "The namespace of the pod identity." + }, + "bindingSelector": { + "type": "string", + "description": "The binding selector to use for the AzureIdentityBinding resource." + }, + "identity": { + "$ref": "#/definitions/UserAssignedIdentity", + "description": "The user assigned identity details." + }, + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "The current provisioning state of the pod identity.", + "enum": [ + "Assigned", + "Updating", + "Deleting", + "Failed" + ], + "x-ms-enum": { + "name": "ManagedClusterPodIdentityProvisioningState", + "modelAsString": true + } + }, + "provisioningInfo": { + "readOnly": true, + "properties": { + "error": { + "$ref": "#/definitions/ManagedClusterPodIdentityProvisioningError", + "description": "Pod identity assignment error (if any)." + } + } + } + }, + "required": [ + "name", + "namespace", + "identity" + ], + "description": "Details about the pod identity assigned to the Managed Cluster." + }, + "ManagedClusterPodIdentityProvisioningError": { + "type": "object", + "properties": { + "error": { + "$ref": "#/definitions/ManagedClusterPodIdentityProvisioningErrorBody", + "description": "Details about the error." + } + }, + "description": "An error response from the pod identity provisioning." + }, + "ManagedClusterPodIdentityProvisioningErrorBody": { + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically." + }, + "message": { + "type": "string", + "description": "A message describing the error, intended to be suitable for display in a user interface." + }, + "target": { + "type": "string", + "description": "The target of the particular error. For example, the name of the property in error." + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/ManagedClusterPodIdentityProvisioningErrorBody" + }, + "description": "A list of additional details about the error." + } + }, + "description": "An error response from the pod identity provisioning." + }, + "ManagedClusterPodIdentityException": { + "properties": { + "name": { + "type": "string", + "description": "The name of the pod identity exception." + }, + "namespace": { + "type": "string", + "description": "The namespace of the pod identity exception." + }, + "podLabels": { + "type": "object", + "description": "The pod labels to match.", + "additionalProperties": { + "type": "string" + } + } + }, + "required": [ + "name", + "namespace", + "podLabels" + ], + "title": "A pod identity exception, which allows pods with certain labels to access the Azure Instance Metadata Service (IMDS) endpoint without being intercepted by the node-managed identity (NMI) server.", + "description": "See [disable AAD Pod Identity for a specific Pod/Application](https://azure.github.io/aad-pod-identity/docs/configure/application_exception/) for more details." + }, + "ManagedClusterPodIdentityProfile": { + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether the pod identity addon is enabled." + }, + "allowNetworkPluginKubenet": { + "type": "boolean", + "title": "Whether pod identity is allowed to run on clusters with Kubenet networking.", + "description": "Running in Kubenet is disabled by default due to the security related nature of AAD Pod Identity and the risks of IP spoofing. See [using Kubenet network plugin with AAD Pod Identity](https://docs.microsoft.com/azure/aks/use-azure-ad-pod-identity#using-kubenet-network-plugin-with-azure-active-directory-pod-managed-identities) for more information." + }, + "userAssignedIdentities": { + "description": "The pod identities to use in the cluster.", + "type": "array", + "items": { + "$ref": "#/definitions/ManagedClusterPodIdentity" + } + }, + "userAssignedIdentityExceptions": { + "description": "The pod identity exceptions to allow.", + "type": "array", + "items": { + "$ref": "#/definitions/ManagedClusterPodIdentityException" + } + } + }, + "title": "The pod identity profile of the Managed Cluster.", + "description": "See [use AAD pod identity](https://docs.microsoft.com/azure/aks/use-azure-ad-pod-identity) for more details on pod identity integration." + }, + "ManagedClusterUpgradeProfile": { + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The ID of the upgrade profile." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the upgrade profile." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The type of the upgrade profile." + }, + "properties": { + "$ref": "#/definitions/ManagedClusterUpgradeProfileProperties", + "description": "The properties of the upgrade profile.", + "x-ms-client-flatten": true + } + }, + "required": [ + "properties" + ], + "description": "The list of available upgrades for compute pools." + }, + "AgentPoolUpgradeProfile": { + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The ID of the agent pool upgrade profile." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the agent pool upgrade profile." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The type of the agent pool upgrade profile." + }, + "properties": { + "$ref": "#/definitions/AgentPoolUpgradeProfileProperties", + "description": "The properties of the agent pool upgrade profile.", + "x-ms-client-flatten": true + } + }, + "required": [ + "properties" + ], + "description": "The list of available upgrades for an agent pool." + }, + "AgentPoolUpgradeProfileProperties": { + "properties": { + "kubernetesVersion": { + "type": "string", + "description": "The Kubernetes version (major.minor.patch)." + }, + "osType": { + "$ref": "#/definitions/OSType" + }, + "upgrades": { + "type": "array", + "items": { + "type": "object", + "properties": { + "kubernetesVersion": { + "type": "string", + "description": "The Kubernetes version (major.minor.patch)." + }, + "isPreview": { + "type": "boolean", + "description": "Whether the Kubernetes version is currently in preview." + } + } + }, + "description": "List of orchestrator types and versions available for upgrade." + }, + "latestNodeImageVersion": { + "type": "string", + "description": "The latest AKS supported node image version." + } + }, + "required": [ + "kubernetesVersion", + "osType" + ], + "description": "The list of available upgrade versions." + }, + "AgentPoolAvailableVersions": { + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The ID of the agent pool version list." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the agent pool version list." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Type of the agent pool version list." + }, + "properties": { + "$ref": "#/definitions/AgentPoolAvailableVersionsProperties", + "description": "Properties of agent pool available versions.", + "x-ms-client-flatten": true + } + }, + "required": [ + "properties" + ], + "description": "The list of available versions for an agent pool." + }, + "AgentPoolAvailableVersionsProperties": { + "properties": { + "agentPoolVersions": { + "type": "array", + "items": { + "type": "object", + "properties": { + "default": { + "type": "boolean", + "description": "Whether this version is the default agent pool version." + }, + "kubernetesVersion": { + "type": "string", + "description": "The Kubernetes version (major.minor.patch)." + }, + "isPreview": { + "type": "boolean", + "description": "Whether Kubernetes version is currently in preview." + } + } + }, + "description": "List of versions available for agent pool." + } + }, + "description": "The list of available agent pool versions." + }, + "OSType": { + "type": "string", + "default": "Linux", + "enum": [ + "Linux", + "Windows" + ], + "x-ms-enum": { + "name": "OSType", + "modelAsString": true, + "values": [ + { + "value": "Linux", + "description": "Use Linux." + }, + { + "value": "Windows", + "description": "Use Windows." + } + ] + }, + "description": "The operating system type. The default is Linux." + }, + "OSSKU": { + "type": "string", + "enum": [ + "Ubuntu", + "CBLMariner" + ], + "x-ms-enum": { + "name": "OSSKU", + "modelAsString": true + }, + "description": "Specifies an OS SKU. This value must not be specified if OSType is Windows." + }, + "ScaleSetPriority": { + "type": "string", + "default": "Regular", + "enum": [ + "Spot", + "Regular" + ], + "x-ms-enum": { + "name": "ScaleSetPriority", + "modelAsString": true, + "values": [ + { + "value": "Spot", + "description": "Spot priority VMs will be used. There is no SLA for spot nodes. See [spot on AKS](https://docs.microsoft.com/azure/aks/spot-node-pool) for more information." + }, + { + "value": "Regular", + "description": "Regular VMs will be used." + } + ] + }, + "description": "The Virtual Machine Scale Set priority." + }, + "ScaleSetEvictionPolicy": { + "type": "string", + "default": "Delete", + "enum": [ + "Delete", + "Deallocate" + ], + "x-ms-enum": { + "name": "ScaleSetEvictionPolicy", + "modelAsString": true, + "values": [ + { + "value": "Delete", + "description": "Nodes in the underlying Scale Set of the node pool are deleted when they're evicted." + }, + { + "value": "Deallocate", + "description": "Nodes in the underlying Scale Set of the node pool are set to the stopped-deallocated state upon eviction. Nodes in the stopped-deallocated state count against your compute quota and can cause issues with cluster scaling or upgrading." + } + ] + }, + "title": "The Virtual Machine Scale Set eviction policy.", + "description": "The eviction policy specifies what to do with the VM when it is evicted. The default is Delete. For more information about eviction see [spot VMs](https://docs.microsoft.com/azure/virtual-machines/spot-vms)" + }, + "SpotMaxPrice": { + "type": "number", + "default": -1, + "title": "The max price (in US Dollars) you are willing to pay for spot instances. Possible values are any decimal value greater than zero or -1 which indicates default price to be up-to on-demand.", + "description": "Possible values are any decimal value greater than zero or -1 which indicates the willingness to pay any on-demand price. For more details on spot pricing, see [spot VMs pricing](https://docs.microsoft.com/azure/virtual-machines/spot-vms#pricing)" + }, + "ScaleDownMode": { + "type": "string", + "enum": [ + "Delete", + "Deallocate" + ], + "x-ms-enum": { + "name": "ScaleDownMode", + "modelAsString": true, + "values": [ + { + "value": "Delete", + "description": "Create new instances during scale up and remove instances during scale down." + }, + { + "value": "Deallocate", + "description": "Attempt to start deallocated instances (if they exist) during scale up and deallocate instances during scale down." + } + ] + }, + "description": "Describes how VMs are added to or removed from Agent Pools. See [billing states](https://docs.microsoft.com/azure/virtual-machines/states-billing)." + }, + "ProximityPlacementGroupID": { + "type": "string", + "description": "The ID for Proximity Placement Group." + }, + "CredentialResults": { + "properties": { + "kubeconfigs": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/CredentialResult" + }, + "description": "Base64-encoded Kubernetes configuration file." + } + }, + "description": "The list credential result response." + }, + "CredentialResult": { + "type": "object", + "properties": { + "name": { + "type": "string", + "readOnly": true, + "description": "The name of the credential." + }, + "value": { + "type": "string", + "format": "byte", + "readOnly": true, + "description": "Base64-encoded Kubernetes configuration file." + } + }, + "description": "The credential result response." + }, + "CloudError": { + "x-ms-external": true, + "properties": { + "error": { + "$ref": "#/definitions/CloudErrorBody", + "description": "Details about the error." + } + }, + "description": "An error response from the Container service." + }, + "CloudErrorBody": { + "x-ms-external": true, + "properties": { + "code": { + "type": "string", + "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically." + }, + "message": { + "type": "string", + "description": "A message describing the error, intended to be suitable for display in a user interface." + }, + "target": { + "type": "string", + "description": "The target of the particular error. For example, the name of the property in error." + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/CloudErrorBody" + }, + "description": "A list of additional details about the error." + } + }, + "description": "An error response from the Container service." + }, + "ManagedClusterSKU": { + "properties": { + "name": { + "type": "string", + "description": "The name of a managed cluster SKU.", + "enum": [ + "Basic" + ], + "x-ms-enum": { + "name": "ManagedClusterSKUName", + "modelAsString": true + } + }, + "tier": { + "type": "string", + "title": "The tier of a managed cluster SKU.", + "description": "If not specified, the default is 'Free'. See [uptime SLA](https://docs.microsoft.com/azure/aks/uptime-sla) for more details.", + "enum": [ + "Paid", + "Free" + ], + "x-ms-enum": { + "name": "ManagedClusterSKUTier", + "modelAsString": true, + "values": [ + { + "value": "Paid", + "description": "Guarantees 99.95% availability of the Kubernetes API server endpoint for clusters that use Availability Zones and 99.9% of availability for clusters that don't use Availability Zones." + }, + { + "value": "Free", + "description": "No guaranteed SLA, no additional charges. Free tier clusters have an SLO of 99.5%." + } + ] + } + } + }, + "description": "The SKU of a Managed Cluster." + }, + "PrivateEndpointConnectionListResult": { + "type": "object", + "description": "A list of private endpoint connections", + "properties": { + "value": { + "description": "The collection value.", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + } + } + }, + "PrivateEndpointConnection": { + "description": "A private endpoint connection", + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The ID of the private endpoint connection." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the private endpoint connection.", + "externalDocs": { + "url": "https://aka.ms/search-naming-rules" + } + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The resource type." + }, + "properties": { + "$ref": "#/definitions/PrivateEndpointConnectionProperties", + "description": "The properties of a private endpoint connection.", + "x-ms-client-flatten": true + } + }, + "x-ms-azure-resource": true + }, + "PrivateEndpointConnectionProperties": { + "type": "object", + "description": "Properties of a private endpoint connection.", + "properties": { + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "The current provisioning state.", + "enum": [ + "Succeeded", + "Creating", + "Deleting", + "Failed" + ], + "x-ms-enum": { + "name": "PrivateEndpointConnectionProvisioningState", + "modelAsString": true + } + }, + "privateEndpoint": { + "$ref": "#/definitions/PrivateEndpoint", + "description": "The resource of private endpoint." + }, + "privateLinkServiceConnectionState": { + "$ref": "#/definitions/PrivateLinkServiceConnectionState", + "description": "A collection of information about the state of the connection between service consumer and provider." + } + }, + "required": [ + "privateLinkServiceConnectionState" + ] + }, + "PrivateEndpoint": { + "type": "object", + "description": "Private endpoint which a connection belongs to.", + "properties": { + "id": { + "description": "The resource ID of the private endpoint", + "type": "string" + } + } + }, + "PrivateLinkServiceConnectionState": { + "description": "The state of a private link service connection.", + "type": "object", + "properties": { + "status": { + "enum": [ + "Pending", + "Approved", + "Rejected", + "Disconnected" + ], + "type": "string", + "description": "The private link service connection status.", + "x-ms-enum": { + "name": "ConnectionStatus", + "modelAsString": true + } + }, + "description": { + "type": "string", + "description": "The private link service connection description." + } + } + }, + "PrivateLinkResourcesListResult": { + "type": "object", + "description": "A list of private link resources", + "properties": { + "value": { + "description": "The collection value.", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateLinkResource" + } + } + } + }, + "PrivateLinkResource": { + "description": "A private link resource", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The ID of the private link resource." + }, + "name": { + "type": "string", + "description": "The name of the private link resource.", + "externalDocs": { + "url": "https://aka.ms/search-naming-rules" + } + }, + "type": { + "type": "string", + "description": "The resource type." + }, + "groupId": { + "type": "string", + "description": "The group ID of the resource." + }, + "requiredMembers": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The RequiredMembers of the resource" + }, + "privateLinkServiceID": { + "readOnly": true, + "type": "string", + "description": "The private link service ID of the resource, this field is exposed only to NRP internally." + } + } + }, + "OSDiskType": { + "type": "string", + "enum": [ + "Managed", + "Ephemeral" + ], + "x-ms-enum": { + "name": "OSDiskType", + "modelAsString": true, + "values": [ + { + "value": "Managed", + "description": "Azure replicates the operating system disk for a virtual machine to Azure storage to avoid data loss should the VM need to be relocated to another host. Since containers aren't designed to have local state persisted, this behavior offers limited value while providing some drawbacks, including slower node provisioning and higher read/write latency." + }, + { + "value": "Ephemeral", + "description": "Ephemeral OS disks are stored only on the host machine, just like a temporary disk. This provides lower read/write latency, along with faster node scaling and cluster upgrades." + } + ] + }, + "title": "The OS disk type to be used for machines in the agent pool.", + "description": "The default is 'Ephemeral' if the VM supports it and has a cache disk larger than the requested OSDiskSizeGB. Otherwise, defaults to 'Managed'. May not be changed after creation. For more information see [Ephemeral OS](https://docs.microsoft.com/azure/aks/cluster-configuration#ephemeral-os)." + }, + "KubeletDiskType": { + "type": "string", + "enum": [ + "OS", + "Temporary" + ], + "x-ms-enum": { + "name": "KubeletDiskType", + "modelAsString": true, + "values": [ + { + "value": "OS", + "description": "Kubelet will use the OS disk for its data." + }, + { + "value": "Temporary", + "description": "Kubelet will use the temporary disk for its data." + } + ] + }, + "description": "Determines the placement of emptyDir volumes, container runtime data root, and Kubelet ephemeral storage." + }, + "KubeletConfig": { + "title": "Kubelet configurations of agent nodes.", + "description": "See [AKS custom node configuration](https://docs.microsoft.com/azure/aks/custom-node-configuration) for more details.", + "type": "object", + "properties": { + "cpuManagerPolicy": { + "type": "string", + "title": "The CPU Manager policy to use.", + "description": "The default is 'none'. See [Kubernetes CPU management policies](https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/#cpu-management-policies) for more information. Allowed values are 'none' and 'static'." + }, + "cpuCfsQuota": { + "type": "boolean", + "title": "If CPU CFS quota enforcement is enabled for containers that specify CPU limits.", + "description": "The default is true." + }, + "cpuCfsQuotaPeriod": { + "type": "string", + "title": "The CPU CFS quota period value.", + "description": "The default is '100ms.' Valid values are a sequence of decimal numbers with an optional fraction and a unit suffix. For example: '300ms', '2h45m'. Supported units are 'ns', 'us', 'ms', 's', 'm', and 'h'." + }, + "imageGcHighThreshold": { + "type": "integer", + "format": "int32", + "title": "The percent of disk usage after which image garbage collection is always run.", + "description": "To disable image garbage collection, set to 100. The default is 85%" + }, + "imageGcLowThreshold": { + "type": "integer", + "format": "int32", + "title": "The percent of disk usage before which image garbage collection is never run.", + "description": "This cannot be set higher than imageGcHighThreshold. The default is 80%" + }, + "topologyManagerPolicy": { + "type": "string", + "title": "The Topology Manager policy to use.", + "description": "For more information see [Kubernetes Topology Manager](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager). The default is 'none'. Allowed values are 'none', 'best-effort', 'restricted', and 'single-numa-node'." + }, + "allowedUnsafeSysctls": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Allowed list of unsafe sysctls or unsafe sysctl patterns (ending in `*`)." + }, + "failSwapOn": { + "type": "boolean", + "description": "If set to true it will make the Kubelet fail to start if swap is enabled on the node." + }, + "containerLogMaxSizeMB": { + "type": "integer", + "format": "int32", + "description": "The maximum size (e.g. 10Mi) of container log file before it is rotated." + }, + "containerLogMaxFiles": { + "type": "integer", + "format": "int32", + "description": "The maximum number of container log files that can be present for a container. The number must be ≥ 2.", + "minimum": 2 + }, + "podMaxPids": { + "type": "integer", + "format": "int32", + "description": "The maximum number of processes per pod." + } + } + }, + "LinuxOSConfig": { + "title": "OS configurations of Linux agent nodes.", + "description": "See [AKS custom node configuration](https://docs.microsoft.com/azure/aks/custom-node-configuration) for more details.", + "type": "object", + "properties": { + "sysctls": { + "$ref": "#/definitions/SysctlConfig", + "description": "Sysctl settings for Linux agent nodes." + }, + "transparentHugePageEnabled": { + "type": "string", + "title": "Whether transparent hugepages are enabled.", + "description": "Valid values are 'always', 'madvise', and 'never'. The default is 'always'. For more information see [Transparent Hugepages](https://www.kernel.org/doc/html/latest/admin-guide/mm/transhuge.html#admin-guide-transhuge)." + }, + "transparentHugePageDefrag": { + "type": "string", + "title": "Whether the kernel should make aggressive use of memory compaction to make more hugepages available.", + "description": "Valid values are 'always', 'defer', 'defer+madvise', 'madvise' and 'never'. The default is 'madvise'. For more information see [Transparent Hugepages](https://www.kernel.org/doc/html/latest/admin-guide/mm/transhuge.html#admin-guide-transhuge)." + }, + "swapFileSizeMB": { + "type": "integer", + "format": "int32", + "description": "The size in MB of a swap file that will be created on each node." + } + } + }, + "SysctlConfig": { + "description": "Sysctl settings for Linux agent nodes.", + "type": "object", + "properties": { + "netCoreSomaxconn": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.core.somaxconn." + }, + "netCoreNetdevMaxBacklog": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.core.netdev_max_backlog." + }, + "netCoreRmemDefault": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.core.rmem_default." + }, + "netCoreRmemMax": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.core.rmem_max." + }, + "netCoreWmemDefault": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.core.wmem_default." + }, + "netCoreWmemMax": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.core.wmem_max." + }, + "netCoreOptmemMax": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.core.optmem_max." + }, + "netIpv4TcpMaxSynBacklog": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.ipv4.tcp_max_syn_backlog." + }, + "netIpv4TcpMaxTwBuckets": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.ipv4.tcp_max_tw_buckets." + }, + "netIpv4TcpFinTimeout": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.ipv4.tcp_fin_timeout." + }, + "netIpv4TcpKeepaliveTime": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.ipv4.tcp_keepalive_time." + }, + "netIpv4TcpKeepaliveProbes": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.ipv4.tcp_keepalive_probes." + }, + "netIpv4TcpkeepaliveIntvl": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.ipv4.tcp_keepalive_intvl." + }, + "netIpv4TcpTwReuse": { + "type": "boolean", + "description": "Sysctl setting net.ipv4.tcp_tw_reuse." + }, + "netIpv4IpLocalPortRange": { + "type": "string", + "description": "Sysctl setting net.ipv4.ip_local_port_range." + }, + "netIpv4NeighDefaultGcThresh1": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.ipv4.neigh.default.gc_thresh1." + }, + "netIpv4NeighDefaultGcThresh2": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.ipv4.neigh.default.gc_thresh2." + }, + "netIpv4NeighDefaultGcThresh3": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.ipv4.neigh.default.gc_thresh3." + }, + "netNetfilterNfConntrackMax": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.netfilter.nf_conntrack_max." + }, + "netNetfilterNfConntrackBuckets": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.netfilter.nf_conntrack_buckets." + }, + "fsInotifyMaxUserWatches": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting fs.inotify.max_user_watches." + }, + "fsFileMax": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting fs.file-max." + }, + "fsAioMaxNr": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting fs.aio-max-nr." + }, + "fsNrOpen": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting fs.nr_open." + }, + "kernelThreadsMax": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting kernel.threads-max." + }, + "vmMaxMapCount": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting vm.max_map_count." + }, + "vmSwappiness": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting vm.swappiness." + }, + "vmVfsCachePressure": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting vm.vfs_cache_pressure." + } + } + }, + "ManagedClusterHTTPProxyConfig": { + "description": "Cluster HTTP proxy configuration.", + "type": "object", + "properties": { + "httpProxy": { + "type": "string", + "description": "The HTTP proxy server endpoint to use." + }, + "httpsProxy": { + "type": "string", + "description": "The HTTPS proxy server endpoint to use." + }, + "noProxy": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The endpoints that should not go through proxy." + }, + "trustedCa": { + "type": "string", + "description": "Alternative CA cert to use for connecting to proxy servers." + } + } + }, + "GPUInstanceProfile": { + "type": "string", + "enum": [ + "MIG1g", + "MIG2g", + "MIG3g", + "MIG4g", + "MIG7g" + ], + "x-ms-enum": { + "name": "GPUInstanceProfile ", + "modelAsString": true + }, + "description": "GPUInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU." + }, + "ExtendedLocationType": { + "type": "string", + "description": "The type of extendedLocation.", + "enum": [ + "EdgeZone" + ], + "x-ms-enum": { + "name": "ExtendedLocationTypes", + "modelAsString": true + } + }, + "ExtendedLocation": { + "description": "The complex type of the extended location.", + "properties": { + "name": { + "type": "string", + "description": "The name of the extended location." + }, + "type": { + "$ref": "#/definitions/ExtendedLocationType", + "description": "The type of the extended location." + } + } + }, + "OSOptionProperty": { + "properties": { + "os-type": { + "type": "string", + "description": "The OS type." + }, + "enable-fips-image": { + "type": "boolean", + "description": "Whether the image is FIPS-enabled." + } + }, + "required": [ + "os-type", + "enable-fips-image" + ], + "description": "OS option property." + }, + "OSOptionPropertyList": { + "properties": { + "osOptionPropertyList": { + "type": "array", + "items": { + "$ref": "#/definitions/OSOptionProperty" + }, + "description": "The list of OS options." + } + }, + "required": [ + "osOptionPropertyList" + ], + "description": "The list of OS option properties." + }, + "OSOptionProfile": { + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The ID of the OS option resource." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the OS option resource." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The type of the OS option resource." + }, + "properties": { + "$ref": "#/definitions/OSOptionPropertyList", + "description": "The list of OS options.", + "x-ms-client-flatten": true + } + }, + "required": [ + "properties" + ], + "description": "The OS option profile." + }, + "EndpointDependency": { + "description": "A domain name that AKS agent nodes are reaching at.", + "type": "object", + "properties": { + "domainName": { + "description": "The domain name of the dependency.", + "type": "string" + }, + "endpointDetails": { + "description": "The Ports and Protocols used when connecting to domainName.", + "type": "array", + "items": { + "$ref": "#/definitions/EndpointDetail" + } + } + } + }, + "EndpointDetail": { + "description": "connect information from the AKS agent nodes to a single endpoint.", + "type": "object", + "properties": { + "ipAddress": { + "description": "An IP Address that Domain Name currently resolves to.", + "type": "string" + }, + "port": { + "format": "int32", + "description": "The port an endpoint is connected to.", + "type": "integer" + }, + "protocol": { + "description": "The protocol used for connection", + "type": "string" + }, + "description": { + "description": "Description of the detail", + "type": "string" + } + } + }, + "OutboundEnvironmentEndpoint": { + "description": "Egress endpoints which AKS agent nodes connect to for common purpose.", + "type": "object", + "properties": { + "category": { + "description": "The category of endpoints accessed by the AKS agent node, e.g. azure-resource-management, apiserver, etc.", + "type": "string" + }, + "endpoints": { + "description": "The endpoints that AKS agent nodes connect to", + "type": "array", + "items": { + "$ref": "#/definitions/EndpointDependency" + } + } + } + }, + "OutboundEnvironmentEndpointCollection": { + "description": "Collection of OutboundEnvironmentEndpoint", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/OutboundEnvironmentEndpoint" + } + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, + "ManagedClusterSecurityProfile": { + "type": "object", + "properties": { + "azureDefender": { + "$ref": "#/definitions/ManagedClusterSecurityProfileAzureDefender", + "description": "Azure Defender settings for the security profile." + } + }, + "description": "Security profile for the container service cluster." + }, + "ManagedClusterSecurityProfileAzureDefender": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable Azure Defender" + }, + "logAnalyticsWorkspaceResourceId": { + "type": "string", + "description": "Resource ID of the Log Analytics workspace to be associated with Azure Defender. When Azure Defender is enabled, this field is required and must be a valid workspace resource ID. When Azure Defender is disabled, leave the field empty." + } + }, + "description": "Azure Defender settings for the security profile." + } + }, + "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.", + "x-ms-parameter-location": "client" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client Api Version.", + "x-ms-parameter-location": "client" + }, + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "description": "The name of the resource group.", + "x-ms-parameter-location": "method" + }, + "ResourceNameParameter": { + "name": "resourceName", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$", + "description": "The name of the managed cluster resource.", + "x-ms-parameter-location": "method" + }, + "LocationParameter": { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The name of a supported Azure region.", + "x-ms-parameter-location": "method" + }, + "ResourceTypeParameter": { + "name": "resource-type", + "in": "query", + "required": false, + "type": "string", + "description": "The resource type for which the OS options needs to be returned", + "x-ms-parameter-location": "method" + }, + "ServerFqdnParameter": { + "name": "server-fqdn", + "in": "query", + "required": false, + "type": "string", + "description": "server fqdn type for credentials to be returned", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/containerservice/resource-manager/readme.go.md b/specification/containerservice/resource-manager/readme.go.md index 6981ca930982..1ecd72072b97 100644 --- a/specification/containerservice/resource-manager/readme.go.md +++ b/specification/containerservice/resource-manager/readme.go.md @@ -20,6 +20,7 @@ azure-arm: true ``` yaml $(go) && $(multiapi) batch: + - tag: package-2021-07 - tag: package-2021-05 - tag: package-2021-03 - tag: package-2021-02 @@ -48,6 +49,15 @@ batch: - tag: package-2017-07 ``` +### Tag: package-2021-07 and go + +These settings apply only when `--package-2021-07 --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag)=='package-2021-07' && $(go) +namespace: containerservice +output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2021-07-01/$(namespace) +``` ### Tag: package-2021-05 and go These settings apply only when `--package-2021-05 --go` is specified on the command line. diff --git a/specification/containerservice/resource-manager/readme.java.md b/specification/containerservice/resource-manager/readme.java.md index 7d2240627e7d..8fd0b2b6bafc 100644 --- a/specification/containerservice/resource-manager/readme.java.md +++ b/specification/containerservice/resource-manager/readme.java.md @@ -37,6 +37,20 @@ batch: - tag: package-2021-02 - tag: package-2021-03 - tag: package-2021-05 + - tag: package-2021-07 +``` + +### Tag: package-2021-07 and java + +These settings apply only when `--tag=package-2021-07` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-2021-07' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.containerservice.v2021_07_01 + output-folder: $(azure-libraries-for-java-folder)/sdk/containerservice/mgmt-v2021_07_01 +regenerate-manager: true +generate-interface: true ``` ### Tag: package-2021-05 and java diff --git a/specification/containerservice/resource-manager/readme.md b/specification/containerservice/resource-manager/readme.md index 739a12201877..8bc3bff594d7 100644 --- a/specification/containerservice/resource-manager/readme.md +++ b/specification/containerservice/resource-manager/readme.md @@ -34,10 +34,19 @@ These are the global settings for the ContainerServices API. ``` yaml openapi-type: arm -tag: package-2021-05 +tag: package-2021-07 ``` +### Tag: package-2021-07 + +These settings apply only when `--tag=package-2021-07` is specified on the command line. + +``` yaml $(tag) == 'package-2021-07' +input-file: + - Microsoft.ContainerService/stable/2021-07-01/managedClusters.json +``` + ### Tag: package-2021-05 These settings apply only when `--tag=package-2021-05` is specified on the command line. @@ -46,6 +55,7 @@ These settings apply only when `--tag=package-2021-05` is specified on the comma input-file: - Microsoft.ContainerService/stable/2021-05-01/managedClusters.json ``` + ### Tag: package-2021-03 These settings apply only when `--tag=package-2021-03` is specified on the command line. @@ -328,6 +338,19 @@ input-file: ``` +### Tag: package-2021-07-01-only + +These settings apply only when `--tag=package-2021-07-01-only` is specified on the command line. + +``` yaml $(tag) == 'package-2021-07-01-only' +input-file: +- Microsoft.ContainerService/stable/2021-07-01/managedClusters.json +directive: + - suppress: DefinitionsPropertiesNamesCamelCase + where: $.definitions.ManagedClusterProperties.properties.autoScalerProfile + reason: Cluster-autoscaler settings are not camel-cased +``` + ### Tag: package-2021-05-01-only These settings apply only when `--tag=package-2021-05-01-only` is specified on the command line. @@ -709,5 +732,3 @@ directive: from: containerService.json reason: ACS service is deprecated so a PATCH endpoint won't be implemented ``` - - diff --git a/specification/containerservice/resource-manager/readme.python.md b/specification/containerservice/resource-manager/readme.python.md index 7dea773f4084..91d6d2079b3b 100644 --- a/specification/containerservice/resource-manager/readme.python.md +++ b/specification/containerservice/resource-manager/readme.python.md @@ -17,6 +17,7 @@ Generate all API versions currently shipped for this package ```yaml $(python) && $(multiapi) && $(track2) batch: + - tag: package-2021-07-01-only - tag: package-2021-05-01-only - tag: package-2021-03-01-only - tag: package-2021-02-01-only @@ -51,6 +52,16 @@ clear-output-folder: false perform-load: false ``` +### Tag: package-2021-07-01-only and python + +These settings apply only when `--tag=package-2021-07-01-only --python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +``` yaml $(tag) == 'package-2021-07-01-only' && $(python) +namespace: azure.mgmt.containerservice.v2021_07_01 +output-folder: $(python-sdks-folder)/containerservice/azure-mgmt-containerservice/azure/mgmt/containerservice/v2021_07_01 +``` + ### Tag: package-2021-05-01-only and python These settings apply only when `--tag=package-2021-05-01-only --python` is specified on the command line. diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/LinkedService.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/LinkedService.json index 3fff57dae074..bde4d26c0db9 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/LinkedService.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/LinkedService.json @@ -2303,6 +2303,10 @@ "CosmosDbMongoDbApiLinkedServiceTypeProperties": { "description": "CosmosDB (MongoDB API) linked service properties.", "properties": { + "isServerVersionAbove32": { + "type": "object", + "description": "Whether the CosmosDB (MongoDB API) server version is higher than 3.2. The default value is false. Type: boolean (or Expression with resultType boolean)." + }, "connectionString": { "description": "The CosmosDB (MongoDB API) connection string. Type: string, SecureString or AzureKeyVaultSecretReference. Type: string, SecureString or AzureKeyVaultSecretReference.", "type": "object" diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2020-10-15-preview/EventGrid.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2020-10-15-preview/EventGrid.json index 82ba19735633..045e22aa2f15 100644 --- a/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2020-10-15-preview/EventGrid.json +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2020-10-15-preview/EventGrid.json @@ -6878,7 +6878,8 @@ }, "isSecret": { "description": "Boolean flag to tell if the attribute contains sensitive information .", - "type": "boolean" + "type": "boolean", + "default": false } } }, @@ -8241,7 +8242,8 @@ "x-ms-enum": { "name": "ResourceKind", "modelAsString": true - } + }, + "default": "Azure" }, "extendedLocation": { "$ref": "#/definitions/ExtendedLocation", diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/EventGrid.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/EventGrid.json index bbff5ae72fb6..cac52caceb07 100644 --- a/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/EventGrid.json +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/EventGrid.json @@ -6871,7 +6871,8 @@ }, "isSecret": { "description": "Boolean flag to tell if the attribute contains sensitive information .", - "type": "boolean" + "type": "boolean", + "default": false } } }, @@ -8228,7 +8229,8 @@ "x-ms-enum": { "name": "ResourceKind", "modelAsString": true - } + }, + "default": "Azure" }, "extendedLocation": { "$ref": "#/definitions/ExtendedLocation", diff --git a/specification/healthcareapis/resource-manager/readme.md b/specification/healthcareapis/resource-manager/readme.md index 91ff7830b5ab..4f545ae574d7 100644 --- a/specification/healthcareapis/resource-manager/readme.md +++ b/specification/healthcareapis/resource-manager/readme.md @@ -28,7 +28,7 @@ These are the global settings for HealthcareApis service. title: HealthcareApisManagementClient description: Azure Healthcare APIs Client openapi-type: arm -tag: package-2021-01 +tag: package-preview-2021-06 azure-arm: true ``` diff --git a/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Locations/Get.json b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Locations/Get.json new file mode 100644 index 000000000000..56eeb061163a --- /dev/null +++ b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Locations/Get.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2021-09-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "iotDefenderLocation": "eastus" + }, + "responses": { + "200": { + "body": { + "name": "eastus", + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.IoTSecurity/locations/eastus", + "type": "Microsoft.IoTSecurity/locations", + "properties": {}, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-04-27T21:53:29.0928001Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-04-27T21:53:29.0928001Z" + } + } + } + } +} diff --git a/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Locations/List.json b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Locations/List.json new file mode 100644 index 000000000000..1808c6e91e67 --- /dev/null +++ b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Locations/List.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2021-09-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "eastus", + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.IoTSecurity/locations/eastus", + "type": "Microsoft.IoTSecurity/locations", + "properties": {}, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-04-27T21:53:29.0928001Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-04-27T21:53:29.0928001Z" + } + } + ] + } + } + } +} diff --git a/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sensors/Delete.json b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sensors/Delete.json new file mode 100644 index 000000000000..185e11fbcad8 --- /dev/null +++ b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sensors/Delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2021-09-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "iotDefenderLocation": "eastus", + "siteName": "site", + "sensorName": "mySensor" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/OnPremiseIotSensors/DownloadActivation.json b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sensors/DownloadActivation.json similarity index 63% rename from specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/OnPremiseIotSensors/DownloadActivation.json rename to specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sensors/DownloadActivation.json index b2236a188f58..58d27d7bd681 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/OnPremiseIotSensors/DownloadActivation.json +++ b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sensors/DownloadActivation.json @@ -1,8 +1,10 @@ { "parameters": { - "api-version": "2020-08-06-preview", + "api-version": "2021-09-01-preview", "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", - "onPremiseIotSensorName": "mySensor" + "iotDefenderLocation": "eastus", + "siteName": "site", + "sensorName": "mySensor" }, "responses": { "200": { diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/OnPremiseIotSensors/DownloadResetPassword.json b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sensors/DownloadResetPassword.json similarity index 68% rename from specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/OnPremiseIotSensors/DownloadResetPassword.json rename to specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sensors/DownloadResetPassword.json index e1fb673660c8..dcbfbaf13e90 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/OnPremiseIotSensors/DownloadResetPassword.json +++ b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sensors/DownloadResetPassword.json @@ -1,8 +1,10 @@ { "parameters": { - "api-version": "2020-08-06-preview", + "api-version": "2021-09-01-preview", "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", - "onPremiseIotSensorName": "mySensor", + "iotDefenderLocation": "eastus", + "siteName": "site", + "sensorName": "mySensor", "body": { "applianceId": "3214-528AV23-D121-D3-E1" } diff --git a/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sensors/Get.json b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sensors/Get.json new file mode 100644 index 000000000000..29fbe0d08bcc --- /dev/null +++ b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sensors/Get.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2021-09-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "iotDefenderLocation": "eastus", + "siteName": "site", + "sensorName": "mySensor" + }, + "responses": { + "200": { + "body": { + "name": "mySensor", + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.IoTSecurity/locations/eastus/sites/site/sensors/mySensor", + "type": "Microsoft.IoTSecurity/locations/sites/sensors", + "properties": { + "connectivityTime": "2020-11-17T12:31:25Z", + "dynamicLearning": true, + "learningMode": true, + "sensorStatus": "Ok", + "sensorVersion": "2020.11.01.1643", + "tiAutomaticUpdates": true, + "tiStatus": "Ok", + "tiVersion": "2020-11-17T12:31:25Z", + "zone": "Zone Name", + "sensorType": "Ot" + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-04-27T21:53:29.0928001Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-04-27T21:53:29.0928001Z" + } + } + } + } +} diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotSensors/Delete.json b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sensors/IoTHub/Delete.json similarity index 73% rename from specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotSensors/Delete.json rename to specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sensors/IoTHub/Delete.json index c24e42c7df41..e1d7a79a61d2 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotSensors/Delete.json +++ b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sensors/IoTHub/Delete.json @@ -1,8 +1,8 @@ { "parameters": { - "api-version": "2020-08-06-preview", + "api-version": "2021-09-01-preview", "scope": "subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Devices/IotHubs/myHub", - "iotSensorName": "mySensor" + "sensorName": "mySensor" }, "responses": { "200": {}, diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotSensors/DownloadActivation.json b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sensors/IoTHub/DownloadActivation.json similarity index 79% rename from specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotSensors/DownloadActivation.json rename to specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sensors/IoTHub/DownloadActivation.json index 7274a7caecc6..8baf6636651b 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotSensors/DownloadActivation.json +++ b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sensors/IoTHub/DownloadActivation.json @@ -1,8 +1,8 @@ { "parameters": { - "api-version": "2020-08-06-preview", + "api-version": "2021-09-01-preview", "scope": "subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Devices/IotHubs/myHub", - "iotSensorName": "mySensor" + "sensorName": "mySensor" }, "responses": { "200": { diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotSensors/DownloadResetPassword.json b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sensors/IoTHub/DownloadResetPassword.json similarity index 82% rename from specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotSensors/DownloadResetPassword.json rename to specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sensors/IoTHub/DownloadResetPassword.json index eb56c01ba963..72e17198b29d 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotSensors/DownloadResetPassword.json +++ b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sensors/IoTHub/DownloadResetPassword.json @@ -1,8 +1,8 @@ { "parameters": { - "api-version": "2020-08-06-preview", + "api-version": "2021-09-01-preview", "scope": "subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Devices/IotHubs/myHub", - "iotSensorName": "mySensor", + "sensorName": "mySensor", "body": { "applianceId": "3214-528AV23-D121-D3-E1" } diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotSensors/Get.json b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sensors/IoTHub/Get.json similarity index 62% rename from specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotSensors/Get.json rename to specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sensors/IoTHub/Get.json index 80c66ce707a7..2c879b84d9fa 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotSensors/Get.json +++ b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sensors/IoTHub/Get.json @@ -1,18 +1,17 @@ { "parameters": { - "api-version": "2020-08-06-preview", + "api-version": "2021-09-01-preview", "scope": "subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Devices/IotHubs/myHub", - "iotSensorName": "mySensor" + "sensorName": "mySensor" }, "responses": { "200": { "body": { "name": "mySensor", - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Devices/IotHubs/myHub/providers/Microsoft.Security/iotSensors/mySensor", - "type": "Microsoft.Security/iotSensors", + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Devices/IotHubs/myHub/providers/Microsoft.IoTSecurity/sensors/mySensor", + "type": "Microsoft.IoTSecurity/sensors", "properties": { "connectivityTime": "2020-11-17T12:31:25Z", - "creationTime": "2020-11-17T12:31:25Z", "dynamicLearning": true, "learningMode": true, "sensorStatus": "Ok", @@ -22,6 +21,14 @@ "tiVersion": "2020-11-17T12:31:25Z", "zone": "Zone Name", "sensorType": "Ot" + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-04-27T21:53:29.0928001Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-04-27T21:53:29.0928001Z" } } } diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotSensors/List.json b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sensors/IoTHub/List.json similarity index 62% rename from specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotSensors/List.json rename to specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sensors/IoTHub/List.json index a7050fb4c8a4..5c6d203121b9 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotSensors/List.json +++ b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sensors/IoTHub/List.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2020-08-06-preview", + "api-version": "2021-09-01-preview", "scope": "subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Devices/IotHubs/myHub" }, "responses": { @@ -9,11 +9,10 @@ "value": [ { "name": "mySensor", - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Devices/IotHubs/myHub/providers/Microsoft.Security/iotSensors/mySensor", - "type": "Microsoft.Security/iotSensors", + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Devices/IotHubs/myHub/providers/Microsoft.IoTSecurity/sensors/mySensor", + "type": "Microsoft.IoTSecurity/sensors", "properties": { "connectivityTime": "2020-11-17T12:31:25Z", - "creationTime": "2020-11-17T12:31:25Z", "dynamicLearning": true, "learningMode": true, "sensorStatus": "Ok", @@ -23,15 +22,22 @@ "tiVersion": "2020-11-17T12:31:25Z", "zone": "Zone Name", "sensorType": "Ot" + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-04-27T21:53:29.0928001Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-04-27T21:53:29.0928001Z" } }, { "name": "otherSensor", - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Devices/IotHubs/myHub/providers/Microsoft.Security/iotSensors/otherSensor", - "type": "Microsoft.Security/iotSensors", + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Devices/IotHubs/myHub/providers/Microsoft.IoTSecurity/sensors/otherSensor", + "type": "Microsoft.IoTSecurity/sensors", "properties": { "connectivityTime": "2020-11-17T12:31:25Z", - "creationTime": "2020-11-17T12:31:25Z", "dynamicLearning": false, "learningMode": false, "sensorStatus": "Disconnected", @@ -41,6 +47,14 @@ "tiVersion": "2020-11-17T12:31:25Z", "zone": "Zone Name", "sensorType": "Ot" + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-04-27T21:53:29.0928001Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-04-27T21:53:29.0928001Z" } } ] diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotSensors/Put.json b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sensors/IoTHub/Put.json similarity index 72% rename from specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotSensors/Put.json rename to specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sensors/IoTHub/Put.json index 835beb4467c0..421900f4248f 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotSensors/Put.json +++ b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sensors/IoTHub/Put.json @@ -1,9 +1,9 @@ { "parameters": { - "api-version": "2020-08-06-preview", + "api-version": "2021-09-01-preview", "scope": "subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Devices/IotHubs/myHub", - "iotSensorName": "mySensor", - "iotSensorsModel": { + "sensorName": "mySensor", + "sensorModel": { "properties": { "tiAutomaticUpdates": true, "zone": "Zone Name", @@ -15,11 +15,10 @@ "200": { "body": { "name": "mySensor", - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Devices/IotHubs/myHub/providers/Microsoft.Security/iotSensors/mySensor", - "type": "Microsoft.Security/iotSensors", + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Devices/IotHubs/myHub/providers/Microsoft.IoTSecurity/sensors/mySensor", + "type": "Microsoft.IoTSecurity/sensors", "properties": { "connectivityTime": "2020-11-17T12:31:25Z", - "creationTime": "2020-11-17T12:31:25Z", "dynamicLearning": true, "learningMode": true, "sensorStatus": "Ok", @@ -35,11 +34,10 @@ "201": { "body": { "name": "mySensor", - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Devices/IotHubs/myHub/providers/Microsoft.Security/iotSensors/mySensor", - "type": "Microsoft.Security/iotSensors", + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Devices/IotHubs/myHub/providers/Microsoft.IoTSecurity/sensors/mySensor", + "type": "Microsoft.IoTSecurity/sensors", "properties": { "connectivityTime": "2020-11-17T12:31:25Z", - "creationTime": "2020-11-17T12:31:25Z", "dynamicLearning": true, "learningMode": true, "sensorStatus": "Ok", @@ -49,6 +47,14 @@ "tiVersion": "2020-11-17T12:31:25Z", "zone": "Zone Name", "sensorType": "Ot" + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-04-27T21:53:29.0928001Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-04-27T21:53:29.0928001Z" } } } diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotSensors/TriggerTiPackageUpdate.json b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sensors/IoTHub/TriggerTiPackageUpdate.json similarity index 72% rename from specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotSensors/TriggerTiPackageUpdate.json rename to specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sensors/IoTHub/TriggerTiPackageUpdate.json index 2aebd9e8ac3b..aa72c8785c2d 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotSensors/TriggerTiPackageUpdate.json +++ b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sensors/IoTHub/TriggerTiPackageUpdate.json @@ -1,8 +1,8 @@ { "parameters": { - "api-version": "2020-08-06-preview", + "api-version": "2021-09-01-preview", "scope": "subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Devices/IotHubs/myHub", - "iotSensorName": "mySensor" + "sensorName": "mySensor" }, "responses": { "200": {} diff --git a/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sensors/List.json b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sensors/List.json new file mode 100644 index 000000000000..2a3d81b9e84b --- /dev/null +++ b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sensors/List.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "api-version": "2021-09-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "iotDefenderLocation": "eastus", + "siteName": "site" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "mySensor", + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.IoTSecurity/locations/eastus/sites/site/sensors/mySensor", + "type": "Microsoft.IoTSecurity/locations/sites/sensors", + "properties": { + "connectivityTime": "2020-11-17T12:31:25Z", + "dynamicLearning": true, + "learningMode": true, + "sensorStatus": "Ok", + "sensorVersion": "2020.11.01.1643", + "tiAutomaticUpdates": true, + "tiStatus": "Ok", + "tiVersion": "2020-11-17T12:31:25Z", + "zone": "Zone Name", + "sensorType": "Ot" + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-04-27T21:53:29.0928001Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-04-27T21:53:29.0928001Z" + } + }, + { + "name": "otherSensor", + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.IoTSecurity/locations/eastus/sites/site/sensors/otherSensor", + "type": "Microsoft.IoTSecurity/locations/sites/sensors", + "properties": { + "connectivityTime": "2020-11-17T12:31:25Z", + "dynamicLearning": false, + "learningMode": false, + "sensorStatus": "Disconnected", + "sensorVersion": "2020.11.01.1643", + "tiAutomaticUpdates": true, + "tiStatus": "Ok", + "tiVersion": "2020-11-17T12:31:25Z", + "zone": "Zone Name", + "sensorType": "Ot" + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-04-27T21:53:29.0928001Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-04-27T21:53:29.0928001Z" + } + } + ] + } + } + } +} diff --git a/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sensors/Put.json b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sensors/Put.json new file mode 100644 index 000000000000..f6b9f99b2158 --- /dev/null +++ b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sensors/Put.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "api-version": "2021-09-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "iotDefenderLocation": "eastus", + "siteName": "site", + "sensorName": "mySensor", + "sensorModel": { + "properties": { + "tiAutomaticUpdates": true, + "zone": "Zone Name", + "sensorType": "Ot" + } + } + }, + "responses": { + "200": { + "body": { + "name": "mySensor", + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.IoTSecurity/locations/eastus/sites/site/sensors/mySensor", + "type": "Microsoft.IoTSecurity/locations/sites/sensors", + "properties": { + "connectivityTime": "2020-11-17T12:31:25Z", + "dynamicLearning": true, + "learningMode": true, + "sensorStatus": "Ok", + "sensorVersion": "2020.11.01.1643", + "tiAutomaticUpdates": true, + "tiStatus": "Ok", + "tiVersion": "2020-11-17T12:31:25Z", + "zone": "Zone Name", + "sensorType": "Ot" + } + } + }, + "201": { + "body": { + "name": "mySensor", + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.IoTSecurity/locations/eastus/sites/site/sensors/mySensor", + "type": "Microsoft.IoTSecurity/locations/sites/sensors", + "properties": { + "connectivityTime": "2020-11-17T12:31:25Z", + "dynamicLearning": true, + "learningMode": true, + "sensorStatus": "Ok", + "sensorVersion": "2020.11.01.1643", + "tiAutomaticUpdates": true, + "tiStatus": "Ok", + "tiVersion": "2020-11-17T12:31:25Z", + "zone": "Zone Name", + "sensorType": "Ot" + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-04-27T21:53:29.0928001Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-04-27T21:53:29.0928001Z" + } + } + } + } +} diff --git a/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sensors/TriggerTiPackageUpdate.json b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sensors/TriggerTiPackageUpdate.json new file mode 100644 index 000000000000..9dd0b146f876 --- /dev/null +++ b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sensors/TriggerTiPackageUpdate.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "api-version": "2021-09-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "iotDefenderLocation": "eastus", + "siteName": "site", + "sensorName": "mySensor" + }, + "responses": { + "200": {} + } +} diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/OnPremiseIotSensors/Delete.json b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sites/Delete.json similarity index 57% rename from specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/OnPremiseIotSensors/Delete.json rename to specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sites/Delete.json index 21b5427051fc..4e5caff95116 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/OnPremiseIotSensors/Delete.json +++ b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sites/Delete.json @@ -1,8 +1,9 @@ { "parameters": { - "api-version": "2020-08-06-preview", + "api-version": "2021-09-01-preview", "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", - "onPremiseIotSensorName": "mySensor" + "iotDefenderLocation": "eastus", + "siteName": "site" }, "responses": { "200": {}, diff --git a/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sites/Get.json b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sites/Get.json new file mode 100644 index 000000000000..5785d533bb5e --- /dev/null +++ b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sites/Get.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2021-09-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "iotDefenderLocation": "eastus", + "siteName": "site" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.IoTSecurity/locations/eastus/sites/site", + "type": "Microsoft.IoTSecurity/locations/sites", + "name": "site", + "properties": { + "displayName": "IoT site name", + "tags": { + "key1": "value1", + "key2": "value2" + } + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-04-27T21:53:29.0928001Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-04-27T21:53:29.0928001Z" + } + } + } + } +} diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotSites/Delete.json b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sites/IoTHub/Delete.json similarity index 83% rename from specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotSites/Delete.json rename to specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sites/IoTHub/Delete.json index dd79858b1cc7..8c7bec2c91b7 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotSites/Delete.json +++ b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sites/IoTHub/Delete.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2020-08-06-preview", + "api-version": "2021-09-01-preview", "scope": "subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Devices/IotHubs/myHub" }, "responses": { diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotSites/Get.json b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sites/IoTHub/Get.json similarity index 55% rename from specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotSites/Get.json rename to specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sites/IoTHub/Get.json index 75d959c8d13c..f01f09e6b032 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotSites/Get.json +++ b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sites/IoTHub/Get.json @@ -1,13 +1,13 @@ { "parameters": { - "api-version": "2020-08-06-preview", + "api-version": "2021-09-01-preview", "scope": "subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Devices/IotHubs/myHub" }, "responses": { "200": { "body": { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Devices/IotHubs/myHub/providers/Microsoft.Security/iotSites/default", - "type": "Microsoft.Security/iotSites", + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Devices/IotHubs/myHub/providers/Microsoft.IoTSecurity/sites/default", + "type": "Microsoft.IoTSecurity/sites", "name": "default", "properties": { "displayName": "IoT site name", @@ -15,6 +15,14 @@ "key1": "value1", "key2": "value2" } + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-04-27T21:53:29.0928001Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-04-27T21:53:29.0928001Z" } } } diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotSites/List.json b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sites/IoTHub/List.json similarity index 50% rename from specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotSites/List.json rename to specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sites/IoTHub/List.json index 9918a1f91395..262e4243745e 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotSites/List.json +++ b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sites/IoTHub/List.json @@ -1,7 +1,7 @@ { "parameters": { - "api-version": "2020-08-06-preview", - "scope": "subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Devices/IotHubs/myHub/iotSites" + "api-version": "2021-09-01-preview", + "scope": "subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Devices/IotHubs/myHub/sites" }, "responses": { "200": { @@ -9,14 +9,22 @@ "value": [ { "name": "default", - "id": "subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Devices/IotHubs/myHub/providers/Microsoft.Security/iotSites/default", - "type": "Microsoft.Security/iotSites", + "id": "subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Devices/IotHubs/myHub/providers/Microsoft.IoTSecurity/sites/default", + "type": "Microsoft.IoTSecurity/sites", "properties": { "displayName": "IoT site name", "tags": { "key1": "value1", "key2": "value2" } + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-04-27T21:53:29.0928001Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-04-27T21:53:29.0928001Z" } } ] diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotSites/Put.json b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sites/IoTHub/Put.json similarity index 55% rename from specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotSites/Put.json rename to specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sites/IoTHub/Put.json index 3062bf75c5fe..d0844663fc24 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotSites/Put.json +++ b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sites/IoTHub/Put.json @@ -1,8 +1,8 @@ { "parameters": { - "api-version": "2020-08-06-preview", + "api-version": "2021-09-01-preview", "scope": "subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Devices/IotHubs/myHub", - "iotSitesModel": { + "siteModel": { "properties": { "displayName": "IoT site name", "tags": { @@ -16,28 +16,44 @@ "200": { "body": { "name": "default", - "id": "subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Devices/IotHubs/myHub/providers/Microsoft.Security/iotSites/default", - "type": "Microsoft.Security/iotSites", + "id": "subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Devices/IotHubs/myHub/providers/Microsoft.IoTSecurity/sites/default", + "type": "Microsoft.IoTSecurity/sites", "properties": { "displayName": "IoT site name", "tags": { "key1": "value1", "key2": "value2" } + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-04-27T21:53:29.0928001Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-04-27T21:53:29.0928001Z" } } }, "201": { "body": { "name": "default", - "id": "subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Devices/IotHubs/myHub/providers/Microsoft.Security/iotSites/default", - "type": "Microsoft.Security/iotSites", + "id": "subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Devices/IotHubs/myHub/providers/Microsoft.IoTSecurity/sites/default", + "type": "Microsoft.IoTSecurity/sites", "properties": { "displayName": "IoT site name", "tags": { "key1": "value1", "key2": "value2" } + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-04-27T21:53:29.0928001Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-04-27T21:53:29.0928001Z" } } } diff --git a/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sites/List.json b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sites/List.json new file mode 100644 index 000000000000..80ced4212195 --- /dev/null +++ b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sites/List.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2021-09-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "iotDefenderLocation": "eastus" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.IoTSecurity/locations/eastus/sites/site", + "type": "Microsoft.IoTSecurity/locations/sites", + "name": "site", + "properties": { + "displayName": "IoT site name", + "tags": { + "key1": "value1", + "key2": "value2" + } + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-04-27T21:53:29.0928001Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-04-27T21:53:29.0928001Z" + } + } + ] + } + } + } +} diff --git a/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sites/Put.json b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sites/Put.json new file mode 100644 index 000000000000..ceeb6649c21f --- /dev/null +++ b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sites/Put.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "api-version": "2021-09-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "iotDefenderLocation": "eastus", + "siteName": "site", + "siteModel": { + "properties": { + "displayName": "IoT site name", + "tags": { + "key1": "value1", + "key2": "value2" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.IoTSecurity/locations/eastus/sites/site", + "type": "Microsoft.IoTSecurity/locations/sites", + "name": "site", + "properties": { + "displayName": "IoT site name", + "tags": { + "key1": "value1", + "key2": "value2" + } + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-04-27T21:53:29.0928001Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-04-27T21:53:29.0928001Z" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.IoTSecurity/locations/eastus/sites/site", + "type": "Microsoft.IoTSecurity/locations/sites", + "name": "site", + "properties": { + "displayName": "IoT site name", + "tags": { + "key1": "value1", + "key2": "value2" + } + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-04-27T21:53:29.0928001Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-04-27T21:53:29.0928001Z" + } + } + } + } +} diff --git a/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/locations.json b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/locations.json new file mode 100644 index 000000000000..e492048bb089 --- /dev/null +++ b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/locations.json @@ -0,0 +1,164 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Defender for IoT", + "description": "API spec for Microsoft.IoTSecurity (Azure Defender for IoT) resource provider", + "version": "2021-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}/providers/Microsoft.IoTSecurity/locations": { + "get": { + "x-ms-examples": { + "List locations": { + "$ref": "./examples/Locations/List.json" + } + }, + "tags": [ + "Locations" + ], + "description": "Lists Defender for IoT locations associated with the given subscription.", + "operationId": "Locations_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/LocationList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.IoTSecurity/locations/{iotDefenderLocation}": { + "get": { + "x-ms-examples": { + "Get location": { + "$ref": "./examples/Locations/Get.json" + } + }, + "tags": [ + "Locations" + ], + "operationId": "Locations_Get", + "description": "Get a Defender for IoT location associated with the given subscription.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/IotDefenderLocation" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/LocationModel" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "LocationList": { + "description": "List of Defender for IoT locations", + "type": "object", + "properties": { + "value": { + "description": "List data", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/LocationModel" + } + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, + "LocationModel": { + "type": "object", + "description": "IoT Defender location", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "IoT Defender location properties", + "$ref": "#/definitions/LocationProperties" + }, + "systemData": { + "readOnly": true, + "type": "object", + "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information.", + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData" + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ] + }, + "LocationProperties": { + "type": "object", + "description": "Defender for IoT location properties", + "properties": {} + } + } +} diff --git a/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/sensors.json b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/sensors.json new file mode 100644 index 000000000000..eee6f46e19f1 --- /dev/null +++ b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/sensors.json @@ -0,0 +1,869 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Defender for IoT", + "description": "API spec for Microsoft.IoTSecurity (Azure Defender for IoT) resource provider", + "version": "2021-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": { + "/{scope}/providers/Microsoft.IoTSecurity/sensors": { + "get": { + "x-ms-examples": { + "List IoT sensors": { + "$ref": "./examples/Sensors/IoTHub/List.json" + } + }, + "tags": [ + "Sensors" + ], + "description": "List IoT sensors", + "operationId": "Sensors_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SensorScope" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SensorsList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/{scope}/providers/Microsoft.IoTSecurity/sensors/{sensorName}": { + "get": { + "x-ms-examples": { + "Get IoT sensor": { + "$ref": "./examples/Sensors/IoTHub/Get.json" + } + }, + "tags": [ + "Sensors" + ], + "operationId": "Sensors_Get", + "description": "Get IoT sensor", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SensorScope" + }, + { + "$ref": "#/parameters/SensorName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SensorModel" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "x-ms-examples": { + "Create or update IoT sensor": { + "$ref": "./examples/Sensors/IoTHub/Put.json" + } + }, + "tags": [ + "Sensors" + ], + "operationId": "Sensors_CreateOrUpdate", + "description": "Create or update IoT sensor", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SensorScope" + }, + { + "$ref": "#/parameters/SensorName" + }, + { + "$ref": "#/parameters/SensorModel" + } + ], + "responses": { + "200": { + "description": "Updated IoT sensor", + "schema": { + "$ref": "#/definitions/SensorModel" + } + }, + "201": { + "description": "Created IoT sensor", + "schema": { + "$ref": "#/definitions/SensorModel" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "x-ms-examples": { + "Delete IoT sensor": { + "$ref": "./examples/Sensors/IoTHub/Delete.json" + } + }, + "tags": [ + "Sensors" + ], + "operationId": "Sensors_Delete", + "description": "Delete IoT sensor", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SensorScope" + }, + { + "$ref": "#/parameters/SensorName" + } + ], + "responses": { + "200": { + "description": "Deleted IoT sensor" + }, + "204": { + "description": "IoT sensor does not exist" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/{scope}/providers/Microsoft.IoTSecurity/sensors/{sensorName}/downloadActivation": { + "post": { + "x-ms-examples": { + "Download activation file": { + "$ref": "./examples/Sensors/IoTHub/DownloadActivation.json" + } + }, + "tags": [ + "Sensors" + ], + "operationId": "Sensors_DownloadActivation", + "description": "Download sensor activation file", + "produces": [ + "application/zip" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SensorScope" + }, + { + "$ref": "#/parameters/SensorName" + } + ], + "responses": { + "200": { + "description": "Downloaded activation file", + "schema": { + "type": "object", + "format": "file" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/{scope}/providers/Microsoft.IoTSecurity/sensors/{sensorName}/downloadResetPassword": { + "post": { + "x-ms-examples": { + "Download file for reset password of the sensor": { + "$ref": "./examples/Sensors/IoTHub/DownloadResetPassword.json" + } + }, + "tags": [ + "Sensors" + ], + "operationId": "Sensors_DownloadResetPassword", + "description": "Download file for reset password of the sensor", + "produces": [ + "application/zip" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SensorScope" + }, + { + "$ref": "#/parameters/SensorName" + }, + { + "in": "body", + "name": "body", + "required": true, + "description": "The reset password input.", + "schema": { + "$ref": "#/definitions/ResetPasswordInput" + }, + "x-ms-parameter-location": "method" + } + ], + "responses": { + "200": { + "description": "Downloaded reset password file", + "schema": { + "type": "object", + "format": "file" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/{scope}/providers/Microsoft.IoTSecurity/sensors/{sensorName}/triggerTiPackageUpdate": { + "post": { + "x-ms-examples": { + "Trigger threat intelligence package update": { + "$ref": "./examples/Sensors/IoTHub/TriggerTiPackageUpdate.json" + } + }, + "tags": [ + "Sensors" + ], + "operationId": "Sensors_TriggerTiPackageUpdate", + "description": "Trigger threat intelligence package update", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SensorScope" + }, + { + "$ref": "#/parameters/SensorName" + } + ], + "responses": { + "200": { + "description": "Triggered threat intelligence package update" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.IoTSecurity/locations/{iotDefenderLocation}/sites/{siteName}/sensors": { + "get": { + "x-ms-examples": { + "List Sensors": { + "$ref": "./examples/Sensors/List.json" + } + }, + "tags": [ + "Sensors" + ], + "description": "List IoT sensors", + "operationId": "SiteSensors_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/IotDefenderLocation" + }, + { + "$ref": "#/parameters/SiteName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SensorsList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.IoTSecurity/locations/{iotDefenderLocation}/sites/{siteName}/sensors/{sensorName}": { + "get": { + "x-ms-examples": { + "Get Sensor": { + "$ref": "./examples/Sensors/Get.json" + } + }, + "tags": [ + "Sensors" + ], + "operationId": "SiteSensors_Get", + "description": "Get IoT sensor", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/IotDefenderLocation" + }, + { + "$ref": "#/parameters/SiteName" + }, + { + "$ref": "#/parameters/SensorName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SensorModel" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "x-ms-examples": { + "Create or update sensor": { + "$ref": "./examples/Sensors/Put.json" + } + }, + "tags": [ + "Sensors" + ], + "operationId": "SiteSensors_CreateOrUpdate", + "description": "Create or update IoT sensor", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/IotDefenderLocation" + }, + { + "$ref": "#/parameters/SiteName" + }, + { + "$ref": "#/parameters/SensorName" + }, + { + "$ref": "#/parameters/SensorModel" + } + ], + "responses": { + "200": { + "description": "Updated IoT sensor", + "schema": { + "$ref": "#/definitions/SensorModel" + } + }, + "201": { + "description": "Created IoT sensor", + "schema": { + "$ref": "#/definitions/SensorModel" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "x-ms-examples": { + "Delete Sensor": { + "$ref": "./examples/Sensors/Delete.json" + } + }, + "tags": [ + "Sensors" + ], + "operationId": "SiteSensors_Delete", + "description": "Delete IoT sensor", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/IotDefenderLocation" + }, + { + "$ref": "#/parameters/SiteName" + }, + { + "$ref": "#/parameters/SensorName" + } + ], + "responses": { + "200": { + "description": "Deleted IoT sensor" + }, + "204": { + "description": "IoT sensor does not exist" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.IoTSecurity/locations/{iotDefenderLocation}/sites/{siteName}/sensors/{sensorName}/downloadActivation": { + "post": { + "x-ms-examples": { + "Download sensor activation file": { + "$ref": "./examples/Sensors/DownloadActivation.json" + } + }, + "tags": [ + "Sensors" + ], + "operationId": "SiteSensors_DownloadActivation", + "description": "Download sensor activation file", + "produces": [ + "application/zip" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/IotDefenderLocation" + }, + { + "$ref": "#/parameters/SiteName" + }, + { + "$ref": "#/parameters/SensorName" + } + ], + "responses": { + "200": { + "description": "Downloaded activation file", + "schema": { + "type": "object", + "format": "file" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.IoTSecurity/locations/{iotDefenderLocation}/sites/{siteName}/sensors/{sensorName}/downloadResetPassword": { + "post": { + "x-ms-examples": { + "Download reset password file of the sensor": { + "$ref": "./examples/Sensors/DownloadResetPassword.json" + } + }, + "tags": [ + "Sensors" + ], + "operationId": "SiteSensors_DownloadResetPassword", + "description": "Download file for reset password of the sensor", + "produces": [ + "application/zip" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/IotDefenderLocation" + }, + { + "$ref": "#/parameters/SiteName" + }, + { + "$ref": "#/parameters/SensorName" + }, + { + "in": "body", + "name": "body", + "required": true, + "description": "The reset password input.", + "schema": { + "$ref": "#/definitions/ResetPasswordInput" + }, + "x-ms-parameter-location": "method" + } + ], + "responses": { + "200": { + "description": "Downloaded reset password file", + "schema": { + "type": "object", + "format": "file" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.IoTSecurity/locations/{iotDefenderLocation}/sites/{siteName}/sensors/{sensorName}/triggerTiPackageUpdate": { + "post": { + "x-ms-examples": { + "Trigger threat intelligence package sensor update": { + "$ref": "./examples/Sensors/TriggerTiPackageUpdate.json" + } + }, + "tags": [ + "Sensors" + ], + "operationId": "SiteSensors_TriggerTiPackageUpdate", + "description": "Trigger threat intelligence package update", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/IotDefenderLocation" + }, + { + "$ref": "#/parameters/SiteName" + }, + { + "$ref": "#/parameters/SensorName" + } + ], + "responses": { + "200": { + "description": "Triggered threat intelligence package update" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "SensorsList": { + "description": "List of IoT sensors", + "type": "object", + "properties": { + "value": { + "description": "List data", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/SensorModel" + } + } + } + }, + "SensorModel": { + "type": "object", + "description": "IoT sensor model", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "IoT sensor properties", + "$ref": "#/definitions/SensorProperties" + }, + "systemData": { + "readOnly": true, + "type": "object", + "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information.", + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData" + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/Resource" + } + ] + }, + "SensorProperties": { + "type": "object", + "description": "IoT sensor properties", + "properties": { + "connectivityTime": { + "description": "Last connectivity time of the IoT sensor", + "readOnly": true, + "type": "string", + "example": "2020-11-17T12:31:25Z" + }, + "dynamicLearning": { + "description": "Dynamic mode status of the IoT sensor", + "example": true, + "readOnly": true, + "type": "boolean" + }, + "learningMode": { + "description": "Learning mode status of the IoT sensor", + "example": true, + "readOnly": true, + "type": "boolean" + }, + "sensorStatus": { + "readOnly": true, + "type": "string", + "example": "Ok", + "description": "Status of the IoT sensor", + "enum": [ + "Ok", + "Disconnected", + "Unavailable" + ], + "x-ms-enum": { + "name": "sensorStatus", + "modelAsString": true, + "values": [ + { + "value": "Ok" + }, + { + "value": "Disconnected" + }, + { + "value": "Unavailable" + } + ] + } + }, + "sensorVersion": { + "description": "Version of the IoT sensor", + "readOnly": true, + "type": "string", + "example": "2020.11.01.1643" + }, + "tiAutomaticUpdates": { + "description": "TI Automatic mode status of the IoT sensor", + "example": true, + "type": "boolean" + }, + "tiStatus": { + "readOnly": true, + "type": "string", + "example": "Ok", + "description": "TI Status of the IoT sensor", + "enum": [ + "Ok", + "Failed", + "InProgress", + "UpdateAvailable" + ], + "x-ms-enum": { + "name": "tiStatus", + "modelAsString": true, + "values": [ + { + "value": "Ok" + }, + { + "value": "Failed" + }, + { + "value": "InProgress" + }, + { + "value": "UpdateAvailable" + } + ] + } + }, + "tiVersion": { + "description": "TI Version of the IoT sensor", + "readOnly": true, + "type": "string", + "example": "2020-11-17T12:31:25Z" + }, + "zone": { + "type": "string", + "description": "Zone of the IoT sensor", + "example": "A12" + }, + "sensorType": { + "description": "Type of sensor", + "example": "Ot", + "type": "string", + "enum": [ + "Ot", + "Enterprise" + ], + "x-ms-enum": { + "name": "sensorType", + "modelAsString": true, + "values": [ + { + "value": "Ot" + }, + { + "value": "Enterprise" + } + ] + } + } + } + }, + "ResetPasswordInput": { + "type": "object", + "description": "Reset password input.", + "properties": { + "applianceId": { + "description": "The appliance id of the sensor.", + "type": "string" + } + } + } + }, + "parameters": { + "SensorScope": { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "Scope of the query (IoT Hub, /providers/Microsoft.Devices/iotHubs/myHub)", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true + }, + "SiteName": { + "name": "siteName", + "in": "path", + "required": true, + "type": "string", + "description": "Site Name", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true + }, + "SensorName": { + "name": "sensorName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of the IoT sensor", + "x-ms-parameter-location": "method" + }, + "SensorModel": { + "name": "sensorModel", + "in": "body", + "required": true, + "description": "The IoT sensor model", + "schema": { + "$ref": "#/definitions/SensorModel" + }, + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/sites.json b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/sites.json new file mode 100644 index 000000000000..940046a2e2c2 --- /dev/null +++ b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/sites.json @@ -0,0 +1,445 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Defender for IoT", + "description": "API spec for Microsoft.IoTSecurity (Azure Defender for IoT) resource provider", + "version": "2021-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": { + "/{scope}/providers/Microsoft.IoTSecurity/sites": { + "get": { + "x-ms-examples": { + "List IoT sites": { + "$ref": "./examples/Sites/IoTHub/List.json" + } + }, + "tags": [ + "Sites" + ], + "description": "List IoT sites", + "operationId": "Sites_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SiteScope" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SitesList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/{scope}/providers/Microsoft.IoTSecurity/sites/default": { + "get": { + "x-ms-examples": { + "Get IoT site": { + "$ref": "./examples/Sites/IoTHub/Get.json" + } + }, + "tags": [ + "Sites" + ], + "operationId": "Sites_Get", + "description": "Get IoT site", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SiteScope" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SiteModel" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "x-ms-examples": { + "Create or update IoT site": { + "$ref": "./examples/Sites/IoTHub/Put.json" + } + }, + "tags": [ + "Sites" + ], + "operationId": "Sites_CreateOrUpdate", + "description": "Create or update IoT site", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SiteScope" + }, + { + "$ref": "#/parameters/SiteModel" + } + ], + "responses": { + "200": { + "description": "Updated IoT site", + "schema": { + "$ref": "#/definitions/SiteModel" + } + }, + "201": { + "description": "Created IoT site", + "schema": { + "$ref": "#/definitions/SiteModel" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "x-ms-examples": { + "Delete IoT site": { + "$ref": "./examples/Sites/IoTHub/Delete.json" + } + }, + "tags": [ + "Sites" + ], + "operationId": "Sites_Delete", + "description": "Delete IoT site", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SiteScope" + } + ], + "responses": { + "200": { + "description": "Deleted IoT site" + }, + "204": { + "description": "IoT site does not exist" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.IoTSecurity/locations/{iotDefenderLocation}/sites": { + "get": { + "x-ms-examples": { + "List sites": { + "$ref": "./examples/Sites/List.json" + } + }, + "tags": [ + "Sites" + ], + "description": "List IoT sites", + "operationId": "LocationSites_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/IotDefenderLocation" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SitesList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.IoTSecurity/locations/{iotDefenderLocation}/sites/{siteName}": { + "get": { + "x-ms-examples": { + "Get site": { + "$ref": "./examples/Sites/Get.json" + } + }, + "tags": [ + "Sites" + ], + "operationId": "LocationSites_Get", + "description": "Get IoT site", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/IotDefenderLocation" + }, + { + "$ref": "#/parameters/SiteName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SiteModel" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "x-ms-examples": { + "Create or update site": { + "$ref": "./examples/Sites/Put.json" + } + }, + "tags": [ + "Sites" + ], + "operationId": "LocationSites_CreateOrUpdate", + "description": "Create or update IoT site", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/IotDefenderLocation" + }, + { + "$ref": "#/parameters/SiteName" + }, + { + "$ref": "#/parameters/SiteModel" + } + ], + "responses": { + "200": { + "description": "Updated IoT site", + "schema": { + "$ref": "#/definitions/SiteModel" + } + }, + "201": { + "description": "Created IoT site", + "schema": { + "$ref": "#/definitions/SiteModel" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "x-ms-examples": { + "Delete Site": { + "$ref": "./examples/Sites/Delete.json" + } + }, + "tags": [ + "Sites" + ], + "operationId": "LocationSites_Delete", + "description": "Delete IoT site", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/IotDefenderLocation" + }, + { + "$ref": "#/parameters/SiteName" + } + ], + "responses": { + "200": { + "description": "Deleted IoT site" + }, + "204": { + "description": "IoT site does not exist" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "SitesList": { + "description": "List of IoT sites", + "type": "object", + "properties": { + "value": { + "description": "List data", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/SiteModel" + } + } + } + }, + "SiteModel": { + "type": "object", + "description": "IoT site model", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "IoT site properties", + "$ref": "#/definitions/SiteProperties" + }, + "systemData": { + "readOnly": true, + "type": "object", + "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information.", + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData" + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ] + }, + "SiteProperties": { + "type": "object", + "description": "IoT site properties", + "properties": { + "displayName": { + "type": "string", + "description": "Display name of the IoT site" + }, + "tags": { + "type": "object", + "description": "Tags of the IoT site", + "additionalProperties": { + "type": "string" + } + } + }, + "required": [ + "displayName" + ] + } + }, + "parameters": { + "SiteScope": { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "Scope of the query (IoT Hub, /providers/Microsoft.Devices/iotHubs/myHub)", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true + }, + "SiteName": { + "name": "siteName", + "in": "path", + "required": true, + "type": "string", + "description": "Site Name", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true + }, + "SiteModel": { + "name": "siteModel", + "in": "body", + "required": true, + "description": "The IoT sites model", + "schema": { + "$ref": "#/definitions/SiteModel" + }, + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/iotsecurity/resource-manager/readme.md b/specification/iotsecurity/resource-manager/readme.md index a90a0ee7699f..bc2661df88a5 100644 --- a/specification/iotsecurity/resource-manager/readme.md +++ b/specification/iotsecurity/resource-manager/readme.md @@ -89,6 +89,26 @@ input-file: - Microsoft.IoTSecurity/preview/2021-07-01-preview/recommendationTypes.json ``` + +``` yaml +title: IoTSecurity +description: API spec for Microsoft.IoTSecurity (Azure Defender for IoT) resource provider +openapi-type: arm +tag: 2021-09-01-preview +``` + +### Tag: 2021-09-01-preview + +These settings apply only when `--tag=2021-09-01-preview` is specified on the command line. + +``` yaml $(tag) == '2021-09-01-preview' +input-file: +- Microsoft.IoTSecurity/preview/2021-02-01-preview/operations.json +- Microsoft.IoTSecurity/preview/2021-09-01-preview/locations.json +- Microsoft.IoTSecurity/preview/2021-09-01-preview/sites.json +- Microsoft.IoTSecurity/preview/2021-09-01-preview/sensors.json +``` + --- # Code Generation diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.3-preview/keys.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.3-preview/keys.json index efc639d42e50..9bbf7753554d 100644 --- a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.3-preview/keys.json +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.3-preview/keys.json @@ -1289,6 +1289,9 @@ "description": "The bytes encoded as a base64url string." } }, + "required": [ + "value" + ], "description": "The get random bytes response object containing the bytes." }, "KeyReleasePolicy": { diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.3-preview/rbac.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.3-preview/rbac.json index d4d03e0c151b..be47595f94bd 100644 --- a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.3-preview/rbac.json +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.3-preview/rbac.json @@ -443,8 +443,7 @@ "RoleAssignmentPropertiesWithScope": { "properties": { "scope": { - "type": "string", - "description": "The role assignment scope." + "$ref": "#/definitions/RoleScope" }, "roleDefinitionId": { "type": "string", @@ -524,7 +523,7 @@ "required": [ "properties" ], - "description": "Role definition creation parameters." + "description": "Role definition create parameters." }, "RoleAssignmentCreateParameters": { "properties": { @@ -536,7 +535,7 @@ "required": [ "properties" ], - "description": "Role assignment creation parameters." + "description": "Role assignment create parameters." }, "RoleDefinitionFilter": { "properties": { @@ -551,31 +550,32 @@ "properties": { "actions": { "type": "array", + "description": "Action permissions that are granted.", "items": { "type": "string" - }, - "description": "Allowed actions." + } }, "notActions": { "type": "array", + "description": "Action permissions that are excluded but not denied. They may be granted by other role definitions assigned to a principal.", "items": { - "type": "string" - }, - "description": "Denied actions." + "type": "string", + "description": "Not actions." + } }, "dataActions": { "type": "array", + "description": "Data action permissions that are granted.", "items": { - "type": "string" - }, - "description": "Allowed Data actions." + "$ref": "#/definitions/DataAction" + } }, "notDataActions": { "type": "array", + "description": "Data action permissions that are excluded but not denied. They may be granted by other role definitions assigned to a principal.", "items": { - "type": "string" - }, - "description": "Denied Data actions." + "$ref": "#/definitions/DataAction" + } } }, "description": "Role definition permissions." @@ -593,6 +593,25 @@ "type": { "type": "string", "description": "The role type.", + "enum": [ + "AKVBuiltInRole", + "CustomRole" + ], + "x-ms-enum": { + "name": "RoleType", + "modelAsString": true, + "values": [ + { + "name": "BuiltInRole", + "value": "AKVBuiltInRole", + "description": "Built in role." + }, + { + "value": "CustomRole", + "description": "Custom role." + } + ] + }, "x-ms-client-name": "roleType" }, "permissions": { @@ -605,7 +624,7 @@ "assignableScopes": { "type": "array", "items": { - "type": "string" + "$ref": "#/definitions/RoleScope" }, "description": "Role definition assignable scopes." } @@ -626,8 +645,15 @@ }, "type": { "type": "string", + "description": "The role definition type.", "readOnly": true, - "description": "The role definition type." + "enum": [ + "Microsoft.Authorization/roleDefinitions" + ], + "x-ms-enum": { + "name": "RoleDefinitionType", + "modelAsString": true + } }, "properties": { "x-ms-client-flatten": true, @@ -652,6 +678,246 @@ } }, "description": "Role definition list operation result." + }, + "RoleScope": { + "type": "string", + "description": "The role scope.", + "enum": [ + "/", + "/keys" + ], + "x-ms-enum": { + "name": "RoleScope", + "modelAsString": true, + "values": [ + { + "name": "Global", + "value": "/", + "description": "Global scope" + }, + { + "name": "Keys", + "value": "/keys", + "description": "Keys scope" + } + ] + } + }, + "DataAction": { + "type": "string", + "description": "Supported permissions for data actions.", + "enum": [ + "Microsoft.KeyVault/managedHsm/keys/read/action", + "Microsoft.KeyVault/managedHsm/keys/write/action", + "Microsoft.KeyVault/managedHsm/keys/deletedKeys/read/action", + "Microsoft.KeyVault/managedHsm/keys/deletedKeys/recover/action", + "Microsoft.KeyVault/managedHsm/keys/backup/action", + "Microsoft.KeyVault/managedHsm/keys/restore/action", + "Microsoft.KeyVault/managedHsm/roleAssignments/delete/action", + "Microsoft.KeyVault/managedHsm/roleAssignments/read/action", + "Microsoft.KeyVault/managedHsm/roleAssignments/write/action", + "Microsoft.KeyVault/managedHsm/roleDefinitions/read/action", + "Microsoft.KeyVault/managedHsm/roleDefinitions/write/action", + "Microsoft.KeyVault/managedHsm/roleDefinitions/delete/action", + "Microsoft.KeyVault/managedHsm/keys/encrypt/action", + "Microsoft.KeyVault/managedHsm/keys/decrypt/action", + "Microsoft.KeyVault/managedHsm/keys/wrap/action", + "Microsoft.KeyVault/managedHsm/keys/unwrap/action", + "Microsoft.KeyVault/managedHsm/keys/sign/action", + "Microsoft.KeyVault/managedHsm/keys/verify/action", + "Microsoft.KeyVault/managedHsm/keys/create", + "Microsoft.KeyVault/managedHsm/keys/delete", + "Microsoft.KeyVault/managedHsm/keys/export/action", + "Microsoft.KeyVault/managedHsm/keys/release/action", + "Microsoft.KeyVault/managedHsm/keys/import/action", + "Microsoft.KeyVault/managedHsm/keys/deletedKeys/delete", + "Microsoft.KeyVault/managedHsm/securitydomain/download/action", + "Microsoft.KeyVault/managedHsm/securitydomain/download/read", + "Microsoft.KeyVault/managedHsm/securitydomain/upload/action", + "Microsoft.KeyVault/managedHsm/securitydomain/upload/read", + "Microsoft.KeyVault/managedHsm/securitydomain/transferkey/read", + "Microsoft.KeyVault/managedHsm/backup/start/action", + "Microsoft.KeyVault/managedHsm/restore/start/action", + "Microsoft.KeyVault/managedHsm/backup/status/action", + "Microsoft.KeyVault/managedHsm/restore/status/action", + "Microsoft.KeyVault/managedHsm/rng/action" + ], + "x-ms-enum": { + "name": "DataAction", + "modelAsString": true, + "values": [ + { + "name": "ReadHsmKey", + "value": "Microsoft.KeyVault/managedHsm/keys/read/action", + "description": "Read HSM key metadata." + }, + { + "name": "WriteHsmKey", + "value": "Microsoft.KeyVault/managedHsm/keys/write/action", + "description": "Update an HSM key." + }, + { + "name": "ReadDeletedHsmKey", + "value": "Microsoft.KeyVault/managedHsm/keys/deletedKeys/read/action", + "description": "Read deleted HSM key." + }, + { + "name": "RecoverDeletedHsmKey", + "value": "Microsoft.KeyVault/managedHsm/keys/deletedKeys/recover/action", + "description": "Recover deleted HSM key." + }, + { + "name": "BackupHsmKeys", + "value": "Microsoft.KeyVault/managedHsm/keys/backup/action", + "description": "Backup HSM keys." + }, + { + "name": "RestoreHsmKeys", + "value": "Microsoft.KeyVault/managedHsm/keys/restore/action", + "description": "Restore HSM keys." + }, + { + "name": "DeleteRoleAssignment", + "value": "Microsoft.KeyVault/managedHsm/roleAssignments/delete/action", + "description": "Delete role assignment." + }, + { + "name": "GetRoleAssignment", + "value": "Microsoft.KeyVault/managedHsm/roleAssignments/read/action", + "description": "Get role assignment." + }, + { + "name": "WriteRoleAssignment", + "value": "Microsoft.KeyVault/managedHsm/roleAssignments/write/action", + "description": "Create or update role assignment." + }, + { + "name": "ReadRoleDefinition", + "value": "Microsoft.KeyVault/managedHsm/roleDefinitions/read/action", + "description": "Get role definition." + }, + { + "name": "WriteRoleDefinition", + "value": "Microsoft.KeyVault/managedHsm/roleDefinitions/write/action", + "description": "Create or update role definition." + }, + { + "name": "DeleteRoleDefinition", + "value": "Microsoft.KeyVault/managedHsm/roleDefinitions/delete/action", + "description": "Delete role definition." + }, + { + "name": "EncryptHsmKey", + "value": "Microsoft.KeyVault/managedHsm/keys/encrypt/action", + "description": "Encrypt using an HSM key." + }, + { + "name": "DecryptHsmKey", + "value": "Microsoft.KeyVault/managedHsm/keys/decrypt/action", + "description": "Decrypt using an HSM key." + }, + { + "name": "WrapHsmKey", + "value": "Microsoft.KeyVault/managedHsm/keys/wrap/action", + "description": "Wrap using an HSM key." + }, + { + "name": "UnwrapHsmKey", + "value": "Microsoft.KeyVault/managedHsm/keys/unwrap/action", + "description": "Unwrap using an HSM key." + }, + { + "name": "SignHsmKey", + "value": "Microsoft.KeyVault/managedHsm/keys/sign/action", + "description": "Sign using an HSM key." + }, + { + "name": "VerifyHsmKey", + "value": "Microsoft.KeyVault/managedHsm/keys/verify/action", + "description": "Verify using an HSM key." + }, + { + "name": "CreateHsmKey", + "value": "Microsoft.KeyVault/managedHsm/keys/create", + "description": "Create an HSM key." + }, + { + "name": "DeleteHsmKey", + "value": "Microsoft.KeyVault/managedHsm/keys/delete", + "description": "Delete an HSM key." + }, + { + "name": "ExportHsmKey", + "value": "Microsoft.KeyVault/managedHsm/keys/export/action", + "description": "Export an HSM key." + }, + { + "name": "ReleaseKey", + "value": "Microsoft.KeyVault/managedHsm/keys/release/action", + "description": "Release an HSM key using Secure Key Release." + }, + { + "name": "ImportHsmKey", + "value": "Microsoft.KeyVault/managedHsm/keys/import/action", + "description": "Import an HSM key." + }, + { + "name": "PurgeDeletedHsmKey", + "value": "Microsoft.KeyVault/managedHsm/keys/deletedKeys/delete", + "description": "Purge a deleted HSM key." + }, + { + "name": "DownloadHsmSecurityDomain", + "value": "Microsoft.KeyVault/managedHsm/securitydomain/download/action", + "description": "Download an HSM security domain." + }, + { + "name": "DownloadHsmSecurityDomainStatus", + "value": "Microsoft.KeyVault/managedHsm/securitydomain/download/read", + "description": "Check status of HSM security domain download." + }, + { + "name": "UploadHsmSecurityDomain", + "value": "Microsoft.KeyVault/managedHsm/securitydomain/upload/action", + "description": "Upload an HSM security domain." + }, + { + "name": "ReadHsmSecurityDomainStatus", + "value": "Microsoft.KeyVault/managedHsm/securitydomain/upload/read", + "description": "Check the status of the HSM security domain exchange file." + }, + { + "name": "ReadHsmSecurityDomainTransferKey", + "value": "Microsoft.KeyVault/managedHsm/securitydomain/transferkey/read", + "description": "Download an HSM security domain transfer key." + }, + { + "name": "StartHsmBackup", + "value": "Microsoft.KeyVault/managedHsm/backup/start/action", + "description": "Start an HSM backup." + }, + { + "name": "StartHsmRestore", + "value": "Microsoft.KeyVault/managedHsm/restore/start/action", + "description": "Start an HSM restore." + }, + { + "name": "ReadHsmBackupStatus", + "value": "Microsoft.KeyVault/managedHsm/backup/status/action", + "description": "Read an HSM backup status." + }, + { + "name": "ReadHsmRestoreStatus", + "value": "Microsoft.KeyVault/managedHsm/restore/status/action", + "description": "Read an HSM restore status." + }, + { + "name": "RandomNumbersGenerate", + "value": "Microsoft.KeyVault/managedHsm/rng/action", + "description": "Generate random numbers." + } + ] + } } }, "parameters": { diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.2/rbac.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.2/rbac.json index 2a14101e482f..9869b2c145b0 100644 --- a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.2/rbac.json +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.2/rbac.json @@ -717,6 +717,8 @@ "Microsoft.KeyVault/managedHsm/roleAssignments/read/action", "Microsoft.KeyVault/managedHsm/roleAssignments/write/action", "Microsoft.KeyVault/managedHsm/roleDefinitions/read/action", + "Microsoft.KeyVault/managedHsm/roleDefinitions/write/action", + "Microsoft.KeyVault/managedHsm/roleDefinitions/delete/action", "Microsoft.KeyVault/managedHsm/keys/encrypt/action", "Microsoft.KeyVault/managedHsm/keys/decrypt/action", "Microsoft.KeyVault/managedHsm/keys/wrap/action", @@ -791,6 +793,16 @@ "value": "Microsoft.KeyVault/managedHsm/roleDefinitions/read/action", "description": "Get role definition." }, + { + "name": "WriteRoleDefinition", + "value": "Microsoft.KeyVault/managedHsm/roleDefinitions/write/action", + "description": "Create or update role definition." + }, + { + "name": "DeleteRoleDefinition", + "value": "Microsoft.KeyVault/managedHsm/roleDefinitions/delete/action", + "description": "Delete role definition." + }, { "name": "EncryptHsmKey", "value": "Microsoft.KeyVault/managedHsm/keys/encrypt/action", diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2021-03-01-preview/mfe.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2021-03-01-preview/mfe.json index 1b4f163670f0..3555e5553b49 100644 --- a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2021-03-01-preview/mfe.json +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2021-03-01-preview/mfe.json @@ -4943,6 +4943,7 @@ }, "targetUtilizationPercentage": { "format": "int32", + "description": "Target CPU usage for the autoscaler.", "type": "integer" } }, @@ -5292,7 +5293,7 @@ "additionalProperties": false }, "BanditPolicy": { - "description": "Defines an early termination policy based on slack criteria, and a frequency and delay interval for evaluation", + "description": "Defines an early termination policy based on slack criteria, and a frequency and delay interval for evaluation.", "type": "object", "allOf": [ { @@ -5302,10 +5303,12 @@ "properties": { "slackAmount": { "format": "float", + "description": "Absolute distance allowed from the best performing run.", "type": "number" }, "slackFactor": { "format": "float", + "description": "Ratio of the allowed distance from the best performing run.", "type": "number" } }, @@ -5399,6 +5402,7 @@ "$ref": "#/definitions/ResourceIdentity" }, "kind": { + "description": "Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type.", "type": "string" }, "properties": { @@ -5421,6 +5425,7 @@ "type": "object", "properties": { "nextLink": { + "description": "The link to the next page of BatchDeployment objects. If null, there are no additional pages.", "type": "string" }, "value": { @@ -5506,6 +5511,7 @@ "$ref": "#/definitions/ResourceIdentity" }, "kind": { + "description": "Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type.", "type": "string" }, "properties": { @@ -5528,6 +5534,7 @@ "type": "object", "properties": { "nextLink": { + "description": "The link to the next page of BatchEndpoint objects. If null, there are no additional pages.", "type": "string" }, "value": { @@ -5779,6 +5786,7 @@ "type": "object", "properties": { "nextLink": { + "description": "The link to the next page of CodeContainer objects. If null, there are no additional pages.", "type": "string" }, "value": { @@ -5868,6 +5876,7 @@ "type": "object", "properties": { "nextLink": { + "description": "The link to the next page of CodeVersion objects. If null, there are no additional pages.", "type": "string" }, "value": { @@ -6229,6 +6238,7 @@ "type": "object", "properties": { "nextLink": { + "description": "The link to the next page of DataContainer objects. If null, there are no additional pages.", "type": "string" }, "value": { @@ -6343,6 +6353,7 @@ "type": "object", "properties": { "nextLink": { + "description": "The link to the next page of DataVersion objects. If null, there are no additional pages.", "type": "string" }, "value": { @@ -6495,6 +6506,7 @@ "type": "object", "properties": { "nextLink": { + "description": "The link to the next page of DatastoreProperties objects. If null, there are no additional pages.", "type": "string" }, "value": { @@ -6525,6 +6537,7 @@ "type": "object", "properties": { "content": { + "description": "The retrieved online deployment logs.", "type": "string" } }, @@ -6702,7 +6715,7 @@ "additionalProperties": false }, "EarlyTerminationPolicy": { - "description": "Early termination policies enable canceling poor-performing runs before they complete", + "description": "Early termination policies enable canceling poor-performing runs before they complete.", "required": [ "policyType" ], @@ -6710,10 +6723,12 @@ "properties": { "delayEvaluation": { "format": "int32", + "description": "Number of intervals by which to delay the first evaluation.", "type": "integer" }, "evaluationInterval": { "format": "int32", + "description": "Interval (number of runs) between policy evaluations.", "type": "integer" }, "policyType": { @@ -6886,6 +6901,7 @@ "type": "object", "properties": { "nextLink": { + "description": "The link to the next page of EnvironmentContainer objects. If null, there are no additional pages.", "type": "string" }, "value": { @@ -6996,6 +7012,7 @@ "type": "object", "properties": { "nextLink": { + "description": "The link to the next page of EnvironmentSpecificationVersion objects. If null, there are no additional pages.", "type": "string" }, "value": { @@ -7078,6 +7095,7 @@ "type": "object", "properties": { "data": { + "description": "Model flavor-specific data.", "type": "object", "additionalProperties": { "type": "string" @@ -7286,6 +7304,7 @@ } }, "provisioningState": { + "description": "Specifies the job provisioning state.", "$ref": "#/definitions/JobProvisioningState", "readOnly": true, "x-ms-mutability": [ @@ -7334,6 +7353,7 @@ "type": "object", "properties": { "nextLink": { + "description": "The link to the next page of JobBase objects. If null, there are no additional pages.", "type": "string" }, "value": { @@ -7376,6 +7396,7 @@ ] }, "properties": { + "description": "Additional properties to set on the endpoint.", "type": "object", "additionalProperties": { "type": "string" @@ -7469,6 +7490,7 @@ ], "properties": { "containerResourceRequirements": { + "description": "Resource requirements for each container instance within an online deployment.", "$ref": "machineLearningServices.json#/definitions/ContainerResourceRequirements" } }, @@ -7687,6 +7709,7 @@ } }, "provisioningState": { + "description": "Specifies the labeling job provisioning state.", "$ref": "#/definitions/JobProvisioningState", "readOnly": true, "x-ms-mutability": [ @@ -7809,6 +7832,7 @@ "type": "object", "properties": { "nextLink": { + "description": "The link to the next page of LabelingJob objects. If null, there are no additional pages.", "type": "string" }, "value": { @@ -7938,6 +7962,7 @@ ], "properties": { "instanceType": { + "description": "Compute instance type.", "type": "string", "x-ms-mutability": [ "create", @@ -7945,6 +7970,7 @@ ] }, "readinessProbe": { + "description": "Deployment container liveness/readiness probe configuration.", "$ref": "#/definitions/ProbeSettings" } }, @@ -7961,6 +7987,7 @@ "properties": { "instanceCount": { "format": "int32", + "description": "Fixed number of instances for this deployment.", "type": "integer" } }, @@ -7981,7 +8008,7 @@ "additionalProperties": false }, "MedianStoppingPolicy": { - "description": "Defines an early termination policy based on running averages of the primary metric of all runs", + "description": "Defines an early termination policy based on running averages of the primary metric of all runs.", "type": "object", "allOf": [ { @@ -8047,6 +8074,7 @@ "type": "object", "properties": { "nextLink": { + "description": "The link to the next page of ModelContainer objects. If null, there are no additional pages.", "type": "string" }, "value": { @@ -8143,6 +8171,7 @@ "type": "object", "properties": { "nextLink": { + "description": "The link to the next page of ModelVersion objects. If null, there are no additional pages.", "type": "string" }, "value": { @@ -8166,6 +8195,7 @@ "properties": { "processCountPerInstance": { "format": "int32", + "description": "Number of processes per MPI node.", "type": "integer", "x-ms-mutability": [ "create", @@ -8210,6 +8240,7 @@ "additionalProperties": false }, "Objective": { + "description": "Optimization objective.", "required": [ "goal", "primaryMetric" @@ -8221,6 +8252,7 @@ "$ref": "#/definitions/Goal" }, "primaryMetric": { + "description": "Name of the metric to optimize.", "pattern": "[a-zA-Z0-9_]", "type": "string" } @@ -8261,6 +8293,7 @@ } }, "livenessProbe": { + "description": "Deployment container liveness/readiness probe configuration.", "$ref": "#/definitions/ProbeSettings" }, "model": { @@ -8283,9 +8316,11 @@ ] }, "requestSettings": { + "description": "Online deployment scoring requests configuration.", "$ref": "#/definitions/OnlineRequestSettings" }, "scaleSettings": { + "description": "Online deployment scaling configuration.", "$ref": "#/definitions/OnlineScaleSettings" } }, @@ -8308,6 +8343,7 @@ "$ref": "#/definitions/ResourceIdentity" }, "kind": { + "description": "Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type.", "type": "string" }, "properties": { @@ -8330,6 +8366,7 @@ "type": "object", "properties": { "nextLink": { + "description": "The link to the next page of OnlineDeployment objects. If null, there are no additional pages.", "type": "string" }, "value": { @@ -8430,6 +8467,7 @@ "$ref": "#/definitions/ResourceIdentity" }, "kind": { + "description": "Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type.", "type": "string" }, "properties": { @@ -8452,6 +8490,7 @@ "type": "object", "properties": { "nextLink": { + "description": "The link to the next page of OnlineEndpoint objects. If null, there are no additional pages.", "type": "string" }, "value": { @@ -8465,10 +8504,12 @@ "additionalProperties": false }, "OnlineRequestSettings": { + "description": "Online deployment scoring requests configuration.", "type": "object", "properties": { "maxConcurrentRequestsPerInstance": { "format": "int32", + "description": "The number of requests allowed to queue at once for this deployment.", "type": "integer" }, "maxQueueWait": { @@ -8485,6 +8526,7 @@ "additionalProperties": false }, "OnlineScaleSettings": { + "description": "Online deployment scaling configuration.", "required": [ "scaleType" ], @@ -8492,13 +8534,16 @@ "properties": { "maxInstances": { "format": "int32", + "description": "Maximum number of instances for this deployment.", "type": "integer" }, "minInstances": { "format": "int32", + "description": "Minimum number of instances for this deployment.", "type": "integer" }, "scaleType": { + "description": "Type of deployment scaling algorithm", "$ref": "#/definitions/ScaleType" } }, @@ -8611,6 +8656,7 @@ ], "properties": { "containerResourceRequirements": { + "description": "Resource requirements for each container instance within an online deployment.", "$ref": "machineLearningServices.json#/definitions/ContainerResourceRequirements" } }, @@ -8637,9 +8683,11 @@ "$ref": "#/definitions/ResourceIdentity" }, "kind": { + "description": "Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type.", "type": "string" }, "location": { + "description": "The geo-location where the resource lives.", "type": "string" }, "properties": { @@ -8647,6 +8695,7 @@ "$ref": "#/definitions/PartialBatchDeployment" }, "tags": { + "description": "Resource tags.", "type": "object", "additionalProperties": { "type": "string" @@ -8679,9 +8728,11 @@ "$ref": "#/definitions/ResourceIdentity" }, "kind": { + "description": "Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type.", "type": "string" }, "location": { + "description": "The geo-location where the resource lives.", "type": "string" }, "properties": { @@ -8689,6 +8740,7 @@ "$ref": "#/definitions/PartialBatchEndpoint" }, "tags": { + "description": "Resource tags.", "type": "object", "additionalProperties": { "type": "string" @@ -8706,6 +8758,7 @@ ], "properties": { "readinessProbe": { + "description": "Deployment container liveness/readiness probe configuration.", "$ref": "#/definitions/ProbeSettings" } }, @@ -8720,19 +8773,23 @@ "type": "object", "properties": { "appInsightsEnabled": { + "description": "Whether AppInsights telemetry is enabled for this online deployment.", "type": "boolean" }, "endpointComputeType": { - "description": "Enum to determine endpoint compute type.", + "description": "The compute type of the endpoint.", "$ref": "#/definitions/EndpointComputeType" }, "livenessProbe": { + "description": "Deployment container liveness/readiness probe configuration.", "$ref": "#/definitions/ProbeSettings" }, "requestSettings": { + "description": "Online deployment scoring requests configuration.", "$ref": "#/definitions/OnlineRequestSettings" }, "scaleSettings": { + "description": "Online deployment scaling configuration.", "$ref": "#/definitions/OnlineScaleSettings" } }, @@ -8747,9 +8804,11 @@ "$ref": "#/definitions/ResourceIdentity" }, "kind": { + "description": "Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type.", "type": "string" }, "location": { + "description": "The geo-location where the resource lives.", "type": "string" }, "properties": { @@ -8757,6 +8816,7 @@ "$ref": "#/definitions/PartialOnlineDeployment" }, "tags": { + "description": "Resource tags.", "type": "object", "additionalProperties": { "type": "string" @@ -8789,9 +8849,11 @@ "$ref": "#/definitions/ResourceIdentity" }, "kind": { + "description": "Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type.", "type": "string" }, "location": { + "description": "The geo-location where the resource lives.", "type": "string" }, "properties": { @@ -8799,6 +8861,7 @@ "$ref": "#/definitions/PartialOnlineEndpoint" }, "tags": { + "description": "Resource tags.", "type": "object", "additionalProperties": { "type": "string" @@ -8808,6 +8871,7 @@ "additionalProperties": false }, "ProbeSettings": { + "description": "Deployment container liveness/readiness probe configuration.", "type": "object", "properties": { "failureThreshold": { @@ -9269,7 +9333,7 @@ ] }, "earlyTermination": { - "description": "Early termination policies enable canceling poor-performing runs before they complete", + "description": "Early termination policies enable canceling poor-performing runs before they complete.", "$ref": "#/definitions/EarlyTerminationPolicy" }, "experimentName": { @@ -9290,13 +9354,16 @@ }, "maxConcurrentTrials": { "format": "int32", + "description": "An upper bound on the number of trials performed in parallel.", "type": "integer" }, "maxTotalTrials": { "format": "int32", + "description": "An upper bound on the number of trials to perform.", "type": "integer" }, "objective": { + "description": "Optimization objective.", "$ref": "#/definitions/Objective" }, "output": { @@ -9355,6 +9422,7 @@ "properties": { "parameterServerCount": { "format": "int32", + "description": "Number of parameter server tasks.", "type": "integer", "x-ms-mutability": [ "create", @@ -9479,6 +9547,7 @@ "properties": { "truncationPercentage": { "format": "int32", + "description": "The percentage of runs to cancel at each evaluation interval.", "type": "integer" } }, diff --git a/specification/maps/data-plane/Common/preview/1.0/common.json b/specification/maps/data-plane/Common/preview/1.0/common.json index a50864ab973e..c860dab1333f 100644 --- a/specification/maps/data-plane/Common/preview/1.0/common.json +++ b/specification/maps/data-plane/Common/preview/1.0/common.json @@ -65,6 +65,7 @@ "created": { "description": "The created timestamp.", "type": "string", + "format": "date-time", "readOnly": true }, "error": { diff --git a/specification/maps/data-plane/Creator/preview/2.0/alias.json b/specification/maps/data-plane/Creator/preview/2.0/alias.json index 4240e14e8d08..5072e87c483b 100644 --- a/specification/maps/data-plane/Creator/preview/2.0/alias.json +++ b/specification/maps/data-plane/Creator/preview/2.0/alias.json @@ -243,6 +243,7 @@ "createdTimestamp": { "description": "The created timestamp for the alias.", "type": "string", + "format": "date-time", "readOnly": true }, "aliasId": { @@ -258,6 +259,7 @@ "lastUpdatedTimestamp": { "description": "The timestamp of the last time the alias was assigned.", "type": "string", + "format": "date-time", "readOnly": true } } @@ -304,6 +306,7 @@ "lastUpdatedTimestamp": { "description": "The timestamp of the last time the alias was assigned.", "type": "string", + "format": "date-time", "readOnly": true } } diff --git a/specification/maps/data-plane/Microsoft.Maps/Alias/preview/1.0/alias.json b/specification/maps/data-plane/Microsoft.Maps/Alias/preview/1.0/alias.json index ddd1e4cadb87..4dcb41ce7393 100644 --- a/specification/maps/data-plane/Microsoft.Maps/Alias/preview/1.0/alias.json +++ b/specification/maps/data-plane/Microsoft.Maps/Alias/preview/1.0/alias.json @@ -167,7 +167,7 @@ "/alias": { "post": { "x-publish": true, - "description": ">[!Important]\n>The Azure Maps Creator services (Preview) version 1.0 will retire on 6 September 2021. Please transition to using version 2.0 by that date.\n>For details, see [Azure Maps Creator Tutorial](https://azure.microsoft.com/en-us/updates/azure-maps-creator-v1-will-be-retired-on-6-september-2021/).\n\n\n**Alias - Create API**\n\n**Applies to**: see pricing [tiers](https://azure.microsoft.com/en-us/pricing/details/azure-maps/).\n
\n\nThis API allows the caller to create an alias.
\nYou can also assign the alias during the create request as well.\n\n\n### Submit Create Request\n\nTo create your alias, you will use a `POST` request. If you would like to assign the alias during the creation, you will pass the `resourceId` query parameter.
\n\n\n### Create Alias Response\n\nThe Create API returns a HTTP `201 Created` response the id of the alias, `aliasId`, in the body.\nThe response will look something like:\n\n```json\n{\n \"aliasId\" : \"d7e5efc8-2239-4387-a286-5bb51aa804e3\"\n}\n```\n\n
", + "description": ">[!Important]\n>The Azure Maps Creator services (Preview) version 1.0 will retire on 6 September 2021. Please transition to using version 2.0 by that date.\n>For details, see [Azure Maps Creator V1 Retirement](https://azure.microsoft.com/en-us/updates/azure-maps-creator-v1-will-be-retired-on-6-september-2021/).\n\n\n**Alias - Create API**\n\n**Applies to**: see pricing [tiers](https://azure.microsoft.com/en-us/pricing/details/azure-maps/).\n
\n\nThis API allows the caller to create an alias.
\nYou can also assign the alias during the create request as well.\n\n\n### Submit Create Request\n\nTo create your alias, you will use a `POST` request. If you would like to assign the alias during the creation, you will pass the `resourceId` query parameter.
\n\n\n### Create Alias Response\n\nThe Create API returns a HTTP `201 Created` response the id of the alias, `aliasId`, in the body.\nThe response will look something like:\n\n```json\n{\n \"aliasId\" : \"d7e5efc8-2239-4387-a286-5bb51aa804e3\"\n}\n```\n\n
", "operationId": "Alias_CreatePreview", "x-ms-examples": { "Create an alias that does not reference any resource": { @@ -214,7 +214,7 @@ }, "get": { "x-publish": true, - "description": ">[!Important]\n>The Azure Maps Creator services (Preview) version 1.0 will retire on 6 September 2021. Please transition to using version 2.0 by that date.\n>For details, see [Azure Maps Creator Tutorial](https://azure.microsoft.com/en-us/updates/azure-maps-creator-v1-will-be-retired-on-6-september-2021/).\n\n\n**Alias - List API**\n\n**Applies to**: see pricing [tiers](https://azure.microsoft.com/en-us/pricing/details/azure-maps/).\n
\n\nThis API allows the caller to fetch a list of all previously successfully created aliases.\n\n\n### Submit List Request\n\nTo list all your aliases, you will issue a `GET` request with no additional parameters.
\n\n\n### List Data Response\n\nThe List API returns the complete list of all aliases in `json` format. The response contains the following details for each alias resource:\n\n > createdTimestamp - The timestamp that the alias was created.\n > aliasId - The id for the alias.\n > resourceId - The id for the resource that this alias references (could be null if the alias has not been assigned).\n > lastUpdatedTimestamp - The last time the alias was assigned to a resource.\n\n\nHere's a sample response returning 2 alias resources: \n\n
\n\n```json\n{\n \"aliases\": [\n {\n \"createdTimestamp\": \"2020-02-13T21:19:11+00:00\",\n \"aliasId\": \"a8a4b8bb-ecf4-fb27-a618-f41721552766\",\n \"resourceId\": \"e89aebb9-70a3-8fe1-32bb-1fbd0c725f14\",\n \"lastUpdatedTimestamp\": \"2020-02-13T21:19:22+00:00\"\n },\n {\n \"createdTimestamp\": \"2020-02-18T19:53:33+00:00\",\n \"aliasId\": \"1856dbfc-7a66-ee5a-bf8d-51dbfe1906f6\",\n \"resourceId\": null,\n \"lastUpdatedTimestamp\": \"2020-02-18T19:53:33+00:00\"\n }\n ]\n}\n```\n\n
", + "description": ">[!Important]\n>The Azure Maps Creator services (Preview) version 1.0 will retire on 6 September 2021. Please transition to using version 2.0 by that date.\n>For details, see [Azure Maps Creator V1 Retirement](https://azure.microsoft.com/en-us/updates/azure-maps-creator-v1-will-be-retired-on-6-september-2021/).\n\n\n**Alias - List API**\n\n**Applies to**: see pricing [tiers](https://azure.microsoft.com/en-us/pricing/details/azure-maps/).\n
\n\nThis API allows the caller to fetch a list of all previously successfully created aliases.\n\n\n### Submit List Request\n\nTo list all your aliases, you will issue a `GET` request with no additional parameters.
\n\n\n### List Data Response\n\nThe List API returns the complete list of all aliases in `json` format. The response contains the following details for each alias resource:\n\n > createdTimestamp - The timestamp that the alias was created.\n > aliasId - The id for the alias.\n > resourceId - The id for the resource that this alias references (could be null if the alias has not been assigned).\n > lastUpdatedTimestamp - The last time the alias was assigned to a resource.\n\n\nHere's a sample response returning 2 alias resources: \n\n
\n\n```json\n{\n \"aliases\": [\n {\n \"createdTimestamp\": \"2020-02-13T21:19:11+00:00\",\n \"aliasId\": \"a8a4b8bb-ecf4-fb27-a618-f41721552766\",\n \"resourceId\": \"e89aebb9-70a3-8fe1-32bb-1fbd0c725f14\",\n \"lastUpdatedTimestamp\": \"2020-02-13T21:19:22+00:00\"\n },\n {\n \"createdTimestamp\": \"2020-02-18T19:53:33+00:00\",\n \"aliasId\": \"1856dbfc-7a66-ee5a-bf8d-51dbfe1906f6\",\n \"resourceId\": null,\n \"lastUpdatedTimestamp\": \"2020-02-18T19:53:33+00:00\"\n }\n ]\n}\n```\n\n
", "operationId": "Alias_ListPreview", "x-ms-examples": { "List all the previously created aliases": { @@ -257,7 +257,7 @@ "/alias/assign/{aliasId}": { "patch": { "x-publish": true, - "description": ">[!Important]\n>The Azure Maps Creator services (Preview) version 1.0 will retire on 6 September 2021. Please transition to using version 2.0 by that date.\n>For details, see [Azure Maps Creator Tutorial](https://azure.microsoft.com/en-us/updates/azure-maps-creator-v1-will-be-retired-on-6-september-2021/).\n\n\n**Alias - Assign API**\n\n**Applies to**: see pricing [tiers](https://azure.microsoft.com/en-us/pricing/details/azure-maps/).\n
\n\nThis API allows the caller to assign an alias to reference a resource.
\n\n\n### Submit Assign Request\n\nTo assign your alias to a resource, you will use a `PATCH` request with the `aliasId` in the path and the `resourceId` passed as a query parameter.
\n\n\n### Create Alias Response\n\nThe Assign API returns a HTTP `204 No Content` response with an empty body, if the alias was assigned successfully.
", + "description": ">[!Important]\n>The Azure Maps Creator services (Preview) version 1.0 will retire on 6 September 2021. Please transition to using version 2.0 by that date.\n>For details, see [Azure Maps Creator V1 Retirement](https://azure.microsoft.com/en-us/updates/azure-maps-creator-v1-will-be-retired-on-6-september-2021/).\n\n\n**Alias - Assign API**\n\n**Applies to**: see pricing [tiers](https://azure.microsoft.com/en-us/pricing/details/azure-maps/).\n
\n\nThis API allows the caller to assign an alias to reference a resource.
\n\n\n### Submit Assign Request\n\nTo assign your alias to a resource, you will use a `PATCH` request with the `aliasId` in the path and the `resourceId` passed as a query parameter.
\n\n\n### Create Alias Response\n\nThe Assign API returns a HTTP `204 No Content` response with an empty body, if the alias was assigned successfully.
", "operationId": "Alias_AssignPreview", "x-ms-examples": { "Assign an alias to a resource": { @@ -306,7 +306,7 @@ "/alias/{aliasId}": { "delete": { "x-publish": true, - "description": ">[!Important]\n>The Azure Maps Creator services (Preview) version 1.0 will retire on 6 September 2021. Please transition to using version 2.0 by that date.\n>For details, see [Azure Maps Creator Tutorial](https://azure.microsoft.com/en-us/updates/azure-maps-creator-v1-will-be-retired-on-6-september-2021/).\n\n\n**Alias - Delete API**\n\n**Applies to**: see pricing [tiers](https://azure.microsoft.com/en-us/pricing/details/azure-maps/).\n
\n\nThis API allows the caller to delete a previously created alias.
\nYou can also use this API to delete old/unused aliases to create space for new content.\nThis API does not delete the references resource, only the alias referencing the resource.\n\n\n### Submit Delete Request\n\nTo delete your alias you will issue a `DELETE` request where the path will contain the `aliasId` of the alias to delete.
\n\n\n### Delete Alias Response\n\nThe Delete API returns a HTTP `204 No Content` response with an empty body, if the alias was deleted successfully.
\nA HTTP `400 Bad Request` error response will be returned if the alias with the passed-in `aliasId` is not found. ", + "description": ">[!Important]\n>The Azure Maps Creator services (Preview) version 1.0 will retire on 6 September 2021. Please transition to using version 2.0 by that date.\n>For details, see [Azure Maps Creator V1 Retirement](https://azure.microsoft.com/en-us/updates/azure-maps-creator-v1-will-be-retired-on-6-september-2021/).\n\n\n**Alias - Delete API**\n\n**Applies to**: see pricing [tiers](https://azure.microsoft.com/en-us/pricing/details/azure-maps/).\n
\n\nThis API allows the caller to delete a previously created alias.
\nYou can also use this API to delete old/unused aliases to create space for new content.\nThis API does not delete the references resource, only the alias referencing the resource.\n\n\n### Submit Delete Request\n\nTo delete your alias you will issue a `DELETE` request where the path will contain the `aliasId` of the alias to delete.
\n\n\n### Delete Alias Response\n\nThe Delete API returns a HTTP `204 No Content` response with an empty body, if the alias was deleted successfully.
\nA HTTP `400 Bad Request` error response will be returned if the alias with the passed-in `aliasId` is not found. ", "operationId": "Alias_DeletePreview", "x-ms-examples": { "Delete previously created alias": { diff --git a/specification/maps/data-plane/Microsoft.Maps/Dataset/preview/1.0/dataset.json b/specification/maps/data-plane/Microsoft.Maps/Dataset/preview/1.0/dataset.json index d7d01af252da..272cdc992bb5 100644 --- a/specification/maps/data-plane/Microsoft.Maps/Dataset/preview/1.0/dataset.json +++ b/specification/maps/data-plane/Microsoft.Maps/Dataset/preview/1.0/dataset.json @@ -259,7 +259,7 @@ "/dataset/create": { "post": { "x-publish": true, - "description": ">[!Important]\n>The Azure Maps Creator services (Preview) version 1.0 will retire on 6 September 2021. Please transition to using version 2.0 by that date.\n>For details, see [Azure Maps Creator Tutorial](https://azure.microsoft.com/en-us/updates/azure-maps-creator-v1-will-be-retired-on-6-september-2021/).\n\n\n**Dataset Create API**\n\n**Applies to**: see pricing [tiers](https://azure.microsoft.com/en-us/pricing/details/azure-maps/).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API \nand SDK. The Dataset APIs are part of Creator. This API allows the caller to create a dataset from data that \nwas uploaded to the Azure Maps Data Service.\n\nYou can use this API in a scenario like uploading a DWG zip package for a building, converting the zip package using \nthe Azure Maps Conversion Service, creating a dataset from the converted zip package. The created dataset can be \nused to create tilesets using the Azure Maps Tileset Service and can be queried via the Azure Maps WFS Service.\n\n## Submit Create Request\n\nTo create your dataset, you will use a `POST` request where the `conversionId` query parameter is an id that represents \nthe converted DWG zip package, the `type` parameter will describe the data type to use for the dataset, the `datasetId`\nparameter will describe if the provided data should be appended to a current dataset and, optionally, the \n`description` query parameter will contain a description (if description is not provided a default description will be \ngiven).\n\nThe Create API is a \n[long-running request](https://aka.ms/am-creator-lrt).", + "description": ">[!Important]\n>The Azure Maps Creator services (Preview) version 1.0 will retire on 6 September 2021. Please transition to using version 2.0 by that date.\n>For details, see [Azure Maps Creator V1 Retirement](https://azure.microsoft.com/en-us/updates/azure-maps-creator-v1-will-be-retired-on-6-september-2021/).\n\n\n**Dataset Create API**\n\n**Applies to**: see pricing [tiers](https://azure.microsoft.com/en-us/pricing/details/azure-maps/).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API \nand SDK. The Dataset APIs are part of Creator. This API allows the caller to create a dataset from data that \nwas uploaded to the Azure Maps Data Service.\n\nYou can use this API in a scenario like uploading a DWG zip package for a building, converting the zip package using \nthe Azure Maps Conversion Service, creating a dataset from the converted zip package. The created dataset can be \nused to create tilesets using the Azure Maps Tileset Service and can be queried via the Azure Maps WFS Service.\n\n## Submit Create Request\n\nTo create your dataset, you will use a `POST` request where the `conversionId` query parameter is an id that represents \nthe converted DWG zip package, the `type` parameter will describe the data type to use for the dataset, the `datasetId`\nparameter will describe if the provided data should be appended to a current dataset and, optionally, the \n`description` query parameter will contain a description (if description is not provided a default description will be \ngiven).\n\nThe Create API is a \n[long-running request](https://aka.ms/am-creator-lrt).", "operationId": "Dataset_CreatePreview", "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { @@ -321,7 +321,7 @@ "/dataset/import/{datasetId}": { "patch": { "x-publish": true, - "description": ">[!Important]\n>The Azure Maps Creator services (Preview) version 1.0 will retire on 6 September 2021. Please transition to using version 2.0 by that date.\n>For details, see [Azure Maps Creator Tutorial](https://azure.microsoft.com/en-us/updates/azure-maps-creator-v1-will-be-retired-on-6-september-2021/).\n\n\n**Dataset Import API**\n\n**Applies to**: see pricing [tiers](https://azure.microsoft.com/en-us/pricing/details/azure-maps/).\n
\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API \nand SDK. The Dataset APIs are part of Creator. This API allows the caller to bulk import data into a dataset \nfrom data that was uploaded to the Azure Maps Data service.
\n\n### Submit Import Request\n\nTo import data into your dataset, you will use a `PATCH` request where the `datasetId` query parameter is the \ndataset you want to import your data into, the `udid` query parameter is the data you want to import, and the `type` \nparameter will describe the data type to use for the import data.
\n\nThe Import API is a \n[long-running request](https://aka.ms/am-creator-lrt).", + "description": ">[!Important]\n>The Azure Maps Creator services (Preview) version 1.0 will retire on 6 September 2021. Please transition to using version 2.0 by that date.\n>For details, see [Azure Maps Creator V1 Retirement](https://azure.microsoft.com/en-us/updates/azure-maps-creator-v1-will-be-retired-on-6-september-2021/).\n\n\n**Dataset Import API**\n\n**Applies to**: see pricing [tiers](https://azure.microsoft.com/en-us/pricing/details/azure-maps/).\n
\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API \nand SDK. The Dataset APIs are part of Creator. This API allows the caller to bulk import data into a dataset \nfrom data that was uploaded to the Azure Maps Data service.
\n\n### Submit Import Request\n\nTo import data into your dataset, you will use a `PATCH` request where the `datasetId` query parameter is the \ndataset you want to import your data into, the `udid` query parameter is the data you want to import, and the `type` \nparameter will describe the data type to use for the import data.
\n\nThe Import API is a \n[long-running request](https://aka.ms/am-creator-lrt).", "operationId": "Dataset_ImportPreview", "x-ms-examples": { "Import data into previously created dataset": { @@ -373,7 +373,7 @@ "/dataset/{datasetId}": { "delete": { "x-publish": true, - "description": ">[!Important]\n>The Azure Maps Creator services (Preview) version 1.0 will retire on 6 September 2021. Please transition to using version 2.0 by that date.\n>For details, see [Azure Maps Creator Tutorial](https://azure.microsoft.com/en-us/updates/azure-maps-creator-v1-will-be-retired-on-6-september-2021/).\n\n\n**Dataset Delete API**\n\n**Applies to**: see pricing [tiers](https://azure.microsoft.com/en-us/pricing/details/azure-maps/).\n
\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. The Dataset APIs are part of Creator.\nThis API allows the caller to delete a previously created dataset.
\nYou can also use this API to delete old/unused datasets to create space for new Creator content.\n\n\n### Submit Delete Request\n\nTo delete your content you will issue a `DELETE` request where the path will contain the `datasetId` of the dataset to delete.
\n\n\n### Delete Data Response\n\nThe Delete API returns a HTTP `204 No Content` response if the dataset resource was deleted successfully.
", + "description": ">[!Important]\n>The Azure Maps Creator services (Preview) version 1.0 will retire on 6 September 2021. Please transition to using version 2.0 by that date.\n>For details, see [Azure Maps Creator V1 Retirement](https://azure.microsoft.com/en-us/updates/azure-maps-creator-v1-will-be-retired-on-6-september-2021/).\n\n\n**Dataset Delete API**\n\n**Applies to**: see pricing [tiers](https://azure.microsoft.com/en-us/pricing/details/azure-maps/).\n
\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. The Dataset APIs are part of Creator.\nThis API allows the caller to delete a previously created dataset.
\nYou can also use this API to delete old/unused datasets to create space for new Creator content.\n\n\n### Submit Delete Request\n\nTo delete your content you will issue a `DELETE` request where the path will contain the `datasetId` of the dataset to delete.
\n\n\n### Delete Data Response\n\nThe Delete API returns a HTTP `204 No Content` response if the dataset resource was deleted successfully.
", "operationId": "Dataset_DeletePreview", "x-ms-examples": { "Delete previously created dataset": { @@ -419,7 +419,7 @@ "/dataset": { "get": { "x-publish": true, - "description": ">[!Important]\n>The Azure Maps Creator services (Preview) version 1.0 will retire on 6 September 2021. Please transition to using version 2.0 by that date.\n>For details, see [Azure Maps Creator Tutorial](https://azure.microsoft.com/en-us/updates/azure-maps-creator-v1-will-be-retired-on-6-september-2021/).\n\n\n**Dataset List API**\n\n**Applies to**: see pricing [tiers](https://azure.microsoft.com/en-us/pricing/details/azure-maps/).\n
\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. The Dataset APIs are part of Creator.\nThis API allows the caller to fetch a list of all previously successfully created datasets.\n\n\n### Submit List Request\n\nTo list all your datasets, you will issue a `GET` request with no additional parameters.
\n\n\n### List Data Response\n\nThe List API returns the complete list of all datasets in `json` format. The response contains the following fields (if they are not null or empty):\n > created - The timestamp the dataset was created.\n > datasetId - The id for the dataset.\n > description - The description for the dataset.\n > datasetSources - The source data that was used when the create request was issued.\n\nThe `datasetSources` describes the source data that was used when the create request was issued and contains the following elements (if they are not null or empty):\n > conversionIds - The list of `conversionId` (null if none were provided).\n > udids - The list of `udid` (null if none were provided).\n > appendDatasetId - The `datasetId` that was used for an append operation (null if none was used).\n > type - The type of data stored in the dataset that was created.\n\nHere's a sample response returning the `timestamp`, `datasetId`, `description`, and `datasetSources` of 3 dataset resources:\n\n
\n\n```json\n{\n \"datasets\": [\n {\n \"timestamp\": \"2020-01-01T22:50:48+00:00\",\n \"datasetId\": \"f6495f62-94f8-0ec2-c252-45626f82fcb2\",\n \"description\": \"Some description or comment for the dataset.\",\n \"datasetSources\": {\n \"conversionIds\": [\n \"15d21452-c9bb-27b6-5e79-743ca5c3205d\"\n ],\n \"type\": \"facility\"\n },\n \"status\": \"Succeeded\"\n },\n {\n \"timestamp\": \"2020-01-01T22:57:53+00:00\",\n \"datasetId\": \"8b1288fa-1958-4a2b-b68e-13a7i5af7d7c\",\n \"description\": \"Create from upload '0c1288fa-2058-4a1b-b68d-13a5f5af7d7c'.\",\n \"datasetSources\": {\n \"udids\": [\n \"0c1288fa-2058-4a1b-b68d-13a5f5af7d7c\"\n ],\n \"type\": \"facility\"\n },\n \"status\": \"Succeeded\"\n },\n {\n \"timestamp\": \"2020-01-01T20:39:36+00:00\",\n \"datasetId\": \"7c1288fa-2058-4a1b-b68f-13a6h5af7d7c\",\n \"description\": \"Some other description or comment for the dataset.\",\n \"datasetSources\": {\n \"conversionIds\": [\n \"15d21452-c9bb-27b6-5e79-743ca5c3205d\"\n ],\n \"appendDatasetId\": \"8b1288fa-1958-4a2b-b68e-13a7i5af7d7c\",\n \"type\": \"facility\"\n },\n \"status\": \"Succeeded\"\n }\n ]\n}\n```\n
", + "description": ">[!Important]\n>The Azure Maps Creator services (Preview) version 1.0 will retire on 6 September 2021. Please transition to using version 2.0 by that date.\n>For details, see [Azure Maps Creator V1 Retirement](https://azure.microsoft.com/en-us/updates/azure-maps-creator-v1-will-be-retired-on-6-september-2021/).\n\n\n**Dataset List API**\n\n**Applies to**: see pricing [tiers](https://azure.microsoft.com/en-us/pricing/details/azure-maps/).\n
\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. The Dataset APIs are part of Creator.\nThis API allows the caller to fetch a list of all previously successfully created datasets.\n\n\n### Submit List Request\n\nTo list all your datasets, you will issue a `GET` request with no additional parameters.
\n\n\n### List Data Response\n\nThe List API returns the complete list of all datasets in `json` format. The response contains the following fields (if they are not null or empty):\n > created - The timestamp the dataset was created.\n > datasetId - The id for the dataset.\n > description - The description for the dataset.\n > datasetSources - The source data that was used when the create request was issued.\n\nThe `datasetSources` describes the source data that was used when the create request was issued and contains the following elements (if they are not null or empty):\n > conversionIds - The list of `conversionId` (null if none were provided).\n > udids - The list of `udid` (null if none were provided).\n > appendDatasetId - The `datasetId` that was used for an append operation (null if none was used).\n > type - The type of data stored in the dataset that was created.\n\nHere's a sample response returning the `timestamp`, `datasetId`, `description`, and `datasetSources` of 3 dataset resources:\n\n
\n\n```json\n{\n \"datasets\": [\n {\n \"timestamp\": \"2020-01-01T22:50:48+00:00\",\n \"datasetId\": \"f6495f62-94f8-0ec2-c252-45626f82fcb2\",\n \"description\": \"Some description or comment for the dataset.\",\n \"datasetSources\": {\n \"conversionIds\": [\n \"15d21452-c9bb-27b6-5e79-743ca5c3205d\"\n ],\n \"type\": \"facility\"\n },\n \"status\": \"Succeeded\"\n },\n {\n \"timestamp\": \"2020-01-01T22:57:53+00:00\",\n \"datasetId\": \"8b1288fa-1958-4a2b-b68e-13a7i5af7d7c\",\n \"description\": \"Create from upload '0c1288fa-2058-4a1b-b68d-13a5f5af7d7c'.\",\n \"datasetSources\": {\n \"udids\": [\n \"0c1288fa-2058-4a1b-b68d-13a5f5af7d7c\"\n ],\n \"type\": \"facility\"\n },\n \"status\": \"Succeeded\"\n },\n {\n \"timestamp\": \"2020-01-01T20:39:36+00:00\",\n \"datasetId\": \"7c1288fa-2058-4a1b-b68f-13a6h5af7d7c\",\n \"description\": \"Some other description or comment for the dataset.\",\n \"datasetSources\": {\n \"conversionIds\": [\n \"15d21452-c9bb-27b6-5e79-743ca5c3205d\"\n ],\n \"appendDatasetId\": \"8b1288fa-1958-4a2b-b68e-13a7i5af7d7c\",\n \"type\": \"facility\"\n },\n \"status\": \"Succeeded\"\n }\n ]\n}\n```\n
", "operationId": "Dataset_ListPreview", "x-ms-examples": { "List all the previously created datasets": { diff --git a/specification/maps/data-plane/Microsoft.Maps/DwgConversion/preview/1.0/dwgconversion.json b/specification/maps/data-plane/Microsoft.Maps/DwgConversion/preview/1.0/dwgconversion.json index e52de4221178..1c058347349c 100644 --- a/specification/maps/data-plane/Microsoft.Maps/DwgConversion/preview/1.0/dwgconversion.json +++ b/specification/maps/data-plane/Microsoft.Maps/DwgConversion/preview/1.0/dwgconversion.json @@ -207,7 +207,7 @@ "/conversion/convert": { "post": { "x-publish": true, - "description": ">[!Important]\n>The Azure Maps Creator services (Preview) version 1.0 will retire on 6 September 2021. Please transition to using version 2.0 by that date.\n>For details, see [Azure Maps Creator Tutorial](https://azure.microsoft.com/en-us/updates/azure-maps-creator-v1-will-be-retired-on-6-september-2021/).\n\n\n**Conversion Create API**\n\n**Applies to**: see pricing [tiers](https://azure.microsoft.com/en-us/pricing/details/azure-maps/).
\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and \nSDK. [This](https://docs.microsoft.com/en-us/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.
\n\nThe Conversion API lets the caller import a set of DWG design files as a zipped [Drawing Package](https://aka.ms/am-drawing-package) into Azure Maps. The [Drawing Package](https://aka.ms/am-drawing-package) should first be \nuploaded using the [Azure Maps Data Service](https://docs.microsoft.com/rest/api/maps/data). Once uploaded, use the \n`udid` returned by the [Data Upload API](https://docs.microsoft.com/rest/api/maps/data/uploadpreview) to call \nthis Conversion API.\n\n## Convert DWG package\n\nThe Conversion API performs a \n[long-running request](https://aka.ms/am-creator-lrt).\n\n## Debug DWG package issues\n\n\nDuring the Conversion process, if there are any issues with the DWG package [errors and warnings](https://aka.ms/am-conversion-errors) are provided in the response along with a *diagnostic package* to visualize \nand diagnose these issues. In case any issues are encountered with your DWG package, the Conversion operation status process as detailed \n[here](https://aka.ms/am-creator-lrt) returns the location of the *diagnostic\npackage* that can be downloaded by the caller to help them visualize and diagnose these issues. The *diagnostic package* location\ncan be found in the properties section of the conversion operation status response and looks like the following:\n\n```json\n{\n \"properties\": {\n \"diagnosticPackageLocation\": \"https://us.atlas.microsoft.com/mapdata/{DiagnosticPackageId}?api-version=1.0\" \n } \n}\n```\n\nThe *diagnostic package* can be downloaded by executing a `HTTP GET` request on the `diagnosticPackageLocation`.\nFor more details on how to use the tool to visualize and diagnose all the errors and warnings see [Drawing Error Visualizer](https://aka.ms/am-drawing-errors-visualizer).
\n\nA conversion operation will be marked as *success* if there are zero or more warnings but will be marked as *failed* if any errors are encountered. ", + "description": ">[!Important]\n>The Azure Maps Creator services (Preview) version 1.0 will retire on 6 September 2021. Please transition to using version 2.0 by that date.\n>For details, see [Azure Maps Creator V1 Retirement](https://azure.microsoft.com/en-us/updates/azure-maps-creator-v1-will-be-retired-on-6-september-2021/).\n\n\n**Conversion Create API**\n\n**Applies to**: see pricing [tiers](https://azure.microsoft.com/en-us/pricing/details/azure-maps/).
\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and \nSDK. [This](https://docs.microsoft.com/en-us/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.
\n\nThe Conversion API lets the caller import a set of DWG design files as a zipped [Drawing Package](https://aka.ms/am-drawing-package) into Azure Maps. The [Drawing Package](https://aka.ms/am-drawing-package) should first be \nuploaded using the [Azure Maps Data Service](https://docs.microsoft.com/rest/api/maps/data). Once uploaded, use the \n`udid` returned by the [Data Upload API](https://docs.microsoft.com/rest/api/maps/data/uploadpreview) to call \nthis Conversion API.\n\n## Convert DWG package\n\nThe Conversion API performs a \n[long-running request](https://aka.ms/am-creator-lrt).\n\n## Debug DWG package issues\n\n\nDuring the Conversion process, if there are any issues with the DWG package [errors and warnings](https://aka.ms/am-conversion-errors) are provided in the response along with a *diagnostic package* to visualize \nand diagnose these issues. In case any issues are encountered with your DWG package, the Conversion operation status process as detailed \n[here](https://aka.ms/am-creator-lrt) returns the location of the *diagnostic\npackage* that can be downloaded by the caller to help them visualize and diagnose these issues. The *diagnostic package* location\ncan be found in the properties section of the conversion operation status response and looks like the following:\n\n```json\n{\n \"properties\": {\n \"diagnosticPackageLocation\": \"https://us.atlas.microsoft.com/mapdata/{DiagnosticPackageId}?api-version=1.0\" \n } \n}\n```\n\nThe *diagnostic package* can be downloaded by executing a `HTTP GET` request on the `diagnosticPackageLocation`.\nFor more details on how to use the tool to visualize and diagnose all the errors and warnings see [Drawing Error Visualizer](https://aka.ms/am-drawing-errors-visualizer).
\n\nA conversion operation will be marked as *success* if there are zero or more warnings but will be marked as *failed* if any errors are encountered. ", "operationId": "Conversion_ConvertPreview", "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { @@ -266,7 +266,7 @@ "/conversion": { "get": { "x-publish": true, - "description": ">[!Important]\n>The Azure Maps Creator services (Preview) version 1.0 will retire on 6 September 2021. Please transition to using version 2.0 by that date.\n>For details, see [Azure Maps Creator Tutorial](https://azure.microsoft.com/en-us/updates/azure-maps-creator-v1-will-be-retired-on-6-september-2021/).\n\n\n**Conversion List API**\n\n**Applies to**: see pricing [tiers](https://azure.microsoft.com/en-us/pricing/details/azure-maps/).
\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/en-us/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.
\n\nThis API allows the caller to fetch a list of all successful data conversions submitted previously using the [Conversion API](https://docs.microsoft.com/en-us/rest/api/maps/conversion/convertpreview). \n\n### Submit List Request\n\nTo list all successful conversions you will issue a `GET` request with no additional parameters.\n\n### List Data Response\n\nThe Conversion List API returns the complete list of all conversion details in `json` format.
\n\nHere is a sample response returning the details of two successful conversion requests: \n\n
\n\n```json\n{\n \"conversions\": \n [\n {\n \"conversionId\": \"54398242-ea6c-1f31-4fa6-79b1ae0fc24d\",\n \"udid\": \"31838736-8b84-11ea-bc55-0242ac130003\",\n \"created\": \"5/19/2020 9:00:00 AM +00:00\",\n \"description\": \"User provided description.\",\n \"featureCounts\": {\n \"DIR\": 1,\n \"LVL\": 3,\n \"FCL\": 1,\n \"UNIT\": 150,\n \"CTG\": 8,\n \"AEL\": 0,\n \"OPN\": 10\n }\n },\n {\n \"conversionId\": \"2acf7d32-8b84-11ea-bc55-0242ac130003\",\n \"udid\": \"1214bc58-8b84-11ea-bc55-0242ac1300039\",\n \"created\": \"5/19/2020 9:00:00 AM +00:00\",\n \"description\": \"User provided description.\",\n \"featureCounts\": {\n \"DIR\": 1,\n \"LVL\": 3,\n \"FCL\": 1,\n \"UNIT\": 150,\n \"CTG\": 8,\n \"AEL\": 0,\n \"OPN\": 10\n }\n }\n ]\n}\n```\n\n
", + "description": ">[!Important]\n>The Azure Maps Creator services (Preview) version 1.0 will retire on 6 September 2021. Please transition to using version 2.0 by that date.\n>For details, see [Azure Maps Creator V1 Retirement](https://azure.microsoft.com/en-us/updates/azure-maps-creator-v1-will-be-retired-on-6-september-2021/).\n\n\n**Conversion List API**\n\n**Applies to**: see pricing [tiers](https://azure.microsoft.com/en-us/pricing/details/azure-maps/).
\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/en-us/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.
\n\nThis API allows the caller to fetch a list of all successful data conversions submitted previously using the [Conversion API](https://docs.microsoft.com/en-us/rest/api/maps/conversion/convertpreview). \n\n### Submit List Request\n\nTo list all successful conversions you will issue a `GET` request with no additional parameters.\n\n### List Data Response\n\nThe Conversion List API returns the complete list of all conversion details in `json` format.
\n\nHere is a sample response returning the details of two successful conversion requests: \n\n
\n\n```json\n{\n \"conversions\": \n [\n {\n \"conversionId\": \"54398242-ea6c-1f31-4fa6-79b1ae0fc24d\",\n \"udid\": \"31838736-8b84-11ea-bc55-0242ac130003\",\n \"created\": \"5/19/2020 9:00:00 AM +00:00\",\n \"description\": \"User provided description.\",\n \"featureCounts\": {\n \"DIR\": 1,\n \"LVL\": 3,\n \"FCL\": 1,\n \"UNIT\": 150,\n \"CTG\": 8,\n \"AEL\": 0,\n \"OPN\": 10\n }\n },\n {\n \"conversionId\": \"2acf7d32-8b84-11ea-bc55-0242ac130003\",\n \"udid\": \"1214bc58-8b84-11ea-bc55-0242ac1300039\",\n \"created\": \"5/19/2020 9:00:00 AM +00:00\",\n \"description\": \"User provided description.\",\n \"featureCounts\": {\n \"DIR\": 1,\n \"LVL\": 3,\n \"FCL\": 1,\n \"UNIT\": 150,\n \"CTG\": 8,\n \"AEL\": 0,\n \"OPN\": 10\n }\n }\n ]\n}\n```\n\n
", "operationId": "Conversion_ListPreview", "x-ms-examples": { "Returns a list of all the data processed by the Conversion Service for the account": { @@ -312,7 +312,7 @@ "/conversion/{conversionId}": { "delete": { "x-publish": true, - "description": ">[!Important]\n>The Azure Maps Creator services (Preview) version 1.0 will retire on 6 September 2021. Please transition to using version 2.0 by that date.\n>For details, see [Azure Maps Creator Tutorial](https://azure.microsoft.com/en-us/updates/azure-maps-creator-v1-will-be-retired-on-6-september-2021/).\n\n\n**Conversion Delete API**\n\n**Applies to**: see pricing [tiers](https://azure.microsoft.com/en-us/pricing/details/azure-maps/).
\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/en-us/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.
\n\nThis API allows the caller to delete any data conversions created previously using the [Conversion API](https://docs.microsoft.com/en-us/rest/api/maps/conversion/convertpreview).\n\n### Submit Delete Request\n\nTo delete your conversion data you will issue a `DELETE` request where the path will contain the `conversionId` of the data to delete.\n\n### Conversion Delete Response\n\nThe Conversion Delete API returns a HTTP `204 No Content` response with an empty body, if the converted data resources were deleted successfully.
\nA HTTP `400 Bad Request` error response will be returned if no resource associated with the passed-in `conversionId` is found. ", + "description": ">[!Important]\n>The Azure Maps Creator services (Preview) version 1.0 will retire on 6 September 2021. Please transition to using version 2.0 by that date.\n>For details, see [Azure Maps Creator V1 Retirement](https://azure.microsoft.com/en-us/updates/azure-maps-creator-v1-will-be-retired-on-6-september-2021/).\n\n\n**Conversion Delete API**\n\n**Applies to**: see pricing [tiers](https://azure.microsoft.com/en-us/pricing/details/azure-maps/).
\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/en-us/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.
\n\nThis API allows the caller to delete any data conversions created previously using the [Conversion API](https://docs.microsoft.com/en-us/rest/api/maps/conversion/convertpreview).\n\n### Submit Delete Request\n\nTo delete your conversion data you will issue a `DELETE` request where the path will contain the `conversionId` of the data to delete.\n\n### Conversion Delete Response\n\nThe Conversion Delete API returns a HTTP `204 No Content` response with an empty body, if the converted data resources were deleted successfully.
\nA HTTP `400 Bad Request` error response will be returned if no resource associated with the passed-in `conversionId` is found. ", "operationId": "Conversion_DeletePreview", "x-ms-examples": { "Delete previously converted content": { diff --git a/specification/maps/data-plane/Microsoft.Maps/FeatureState/preview/1.0/featurestate.json b/specification/maps/data-plane/Microsoft.Maps/FeatureState/preview/1.0/featurestate.json index f0b1034f08f8..2ba054df55af 100644 --- a/specification/maps/data-plane/Microsoft.Maps/FeatureState/preview/1.0/featurestate.json +++ b/specification/maps/data-plane/Microsoft.Maps/FeatureState/preview/1.0/featurestate.json @@ -195,7 +195,7 @@ "/featureState/stateset/{statesetId}": { "get": { "x-publish": true, - "description": ">[!Important]\n>The Azure Maps Creator services (Preview) version 1.0 will retire on 6 September 2021. Please transition to using version 2.0 by that date.\n>For details, see [Azure Maps Creator Tutorial](https://azure.microsoft.com/en-us/updates/azure-maps-creator-v1-will-be-retired-on-6-september-2021/).\n\n\n**Applies to**: see pricing [tiers](https://azure.microsoft.com/en-us/pricing/details/azure-maps/).\n
\n\nThis GET API allows the user to get the stateset Information.\n\nThe stateset Information includes the datasetId associated to the stateset, and the styles of that stateset.", + "description": ">[!Important]\n>The Azure Maps Creator services (Preview) version 1.0 will retire on 6 September 2021. Please transition to using version 2.0 by that date.\n>For details, see [Azure Maps Creator V1 Retirement](https://azure.microsoft.com/en-us/updates/azure-maps-creator-v1-will-be-retired-on-6-september-2021/).\n\n\n**Applies to**: see pricing [tiers](https://azure.microsoft.com/en-us/pricing/details/azure-maps/).\n
\n\nThis GET API allows the user to get the stateset Information.\n\nThe stateset Information includes the datasetId associated to the stateset, and the styles of that stateset.", "operationId": "FeatureState_GetStatesetPreview", "x-ms-examples": { "Get stateset information with a statesetId": { @@ -239,7 +239,7 @@ }, "delete": { "x-publish": true, - "description": ">[!Important]\n>The Azure Maps Creator services (Preview) version 1.0 will retire on 6 September 2021. Please transition to using version 2.0 by that date.\n>For details, see [Azure Maps Creator Tutorial](https://azure.microsoft.com/en-us/updates/azure-maps-creator-v1-will-be-retired-on-6-september-2021/).\n\n\n**Applies to**: see pricing [tiers](https://azure.microsoft.com/en-us/pricing/details/azure-maps/).
This DELETE API allows the user to delete the stateset and the associated data.", + "description": ">[!Important]\n>The Azure Maps Creator services (Preview) version 1.0 will retire on 6 September 2021. Please transition to using version 2.0 by that date.\n>For details, see [Azure Maps Creator V1 Retirement](https://azure.microsoft.com/en-us/updates/azure-maps-creator-v1-will-be-retired-on-6-september-2021/).\n\n\n**Applies to**: see pricing [tiers](https://azure.microsoft.com/en-us/pricing/details/azure-maps/).
This DELETE API allows the user to delete the stateset and the associated data.", "operationId": "FeatureState_DeleteStatesetPreview", "x-ms-examples": { "Delete an existing stateset": { @@ -280,7 +280,7 @@ }, "put": { "x-publish": true, - "description": ">[!Important]\n>The Azure Maps Creator services (Preview) version 1.0 will retire on 6 September 2021. Please transition to using version 2.0 by that date.\n>For details, see [Azure Maps Creator Tutorial](https://azure.microsoft.com/en-us/updates/azure-maps-creator-v1-will-be-retired-on-6-september-2021/).\n\n\n**Applies to**: see pricing [tiers](https://azure.microsoft.com/en-us/pricing/details/azure-maps/).\n
\n\nThis PUT API allows the user to update the stateset style rules.", + "description": ">[!Important]\n>The Azure Maps Creator services (Preview) version 1.0 will retire on 6 September 2021. Please transition to using version 2.0 by that date.\n>For details, see [Azure Maps Creator V1 Retirement](https://azure.microsoft.com/en-us/updates/azure-maps-creator-v1-will-be-retired-on-6-september-2021/).\n\n\n**Applies to**: see pricing [tiers](https://azure.microsoft.com/en-us/pricing/details/azure-maps/).\n
\n\nThis PUT API allows the user to update the stateset style rules.", "operationId": "FeatureState_PutStatesetPreview", "x-ms-examples": { "Update stateset style rules with a statesetId": { @@ -332,7 +332,7 @@ "/featureState/stateset": { "post": { "x-publish": true, - "description": ">[!Important]\n>The Azure Maps Creator services (Preview) version 1.0 will retire on 6 September 2021. Please transition to using version 2.0 by that date.\n>For details, see [Azure Maps Creator Tutorial](https://azure.microsoft.com/en-us/updates/azure-maps-creator-v1-will-be-retired-on-6-september-2021/).\n\n\n**Applies to**: see pricing [tiers](https://azure.microsoft.com/en-us/pricing/details/azure-maps/).\n
\n\nThis POST API allows the user to create a new Stateset and define stateset style using request body.\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. The Feature State API is part of Creator. \n\nThe Feature State service allows the user to update the states of a feature and query them to be used in other services. The dynamic properties of a feature that don't belong to the dataset are referred to as *states* here.\n\nThis Feature State service pivot on the Stateset. Like Tileset, Stateset encapsulates the storage mechanism for feature states for a dataset.\n\nOnce the stateset is created, users can use that statesetId to post feature state updates and retrieve the current feature states. A feature can have only one state at a given point in time. \n\nFeature state is defined by the key name, value and the timestamp. When a feature state update is posted to Azure Maps, the state value gets updated only if the provided state’s timestamp is later than the stored timestamp. \n\nAzure Maps MapControl provides a way to use these feature states to style the features. Please refer to the State Tile documentation for more information.", + "description": ">[!Important]\n>The Azure Maps Creator services (Preview) version 1.0 will retire on 6 September 2021. Please transition to using version 2.0 by that date.\n>For details, see [Azure Maps Creator V1 Retirement](https://azure.microsoft.com/en-us/updates/azure-maps-creator-v1-will-be-retired-on-6-september-2021/).\n\n\n**Applies to**: see pricing [tiers](https://azure.microsoft.com/en-us/pricing/details/azure-maps/).\n
\n\nThis POST API allows the user to create a new Stateset and define stateset style using request body.\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. The Feature State API is part of Creator. \n\nThe Feature State service allows the user to update the states of a feature and query them to be used in other services. The dynamic properties of a feature that don't belong to the dataset are referred to as *states* here.\n\nThis Feature State service pivot on the Stateset. Like Tileset, Stateset encapsulates the storage mechanism for feature states for a dataset.\n\nOnce the stateset is created, users can use that statesetId to post feature state updates and retrieve the current feature states. A feature can have only one state at a given point in time. \n\nFeature state is defined by the key name, value and the timestamp. When a feature state update is posted to Azure Maps, the state value gets updated only if the provided state’s timestamp is later than the stored timestamp. \n\nAzure Maps MapControl provides a way to use these feature states to style the features. Please refer to the State Tile documentation for more information.", "operationId": "FeatureState_CreateStatesetPreview", "x-ms-examples": { "Create a new stateset with a datasetId": { @@ -385,7 +385,7 @@ }, "get": { "x-publish": true, - "description": ">[!Important]\n>The Azure Maps Creator services (Preview) version 1.0 will retire on 6 September 2021. Please transition to using version 2.0 by that date.\n>For details, see [Azure Maps Creator Tutorial](https://azure.microsoft.com/en-us/updates/azure-maps-creator-v1-will-be-retired-on-6-september-2021/).\n\n\n**Applies to**: see pricing [tiers](https://azure.microsoft.com/en-us/pricing/details/azure-maps/).
This API allows the caller to fetch a list of all previously successfully created statesets.", + "description": ">[!Important]\n>The Azure Maps Creator services (Preview) version 1.0 will retire on 6 September 2021. Please transition to using version 2.0 by that date.\n>For details, see [Azure Maps Creator V1 Retirement](https://azure.microsoft.com/en-us/updates/azure-maps-creator-v1-will-be-retired-on-6-september-2021/).\n\n\n**Applies to**: see pricing [tiers](https://azure.microsoft.com/en-us/pricing/details/azure-maps/).
This API allows the caller to fetch a list of all previously successfully created statesets.", "operationId": "FeatureState_ListStatesetPreview", "x-ms-examples": { "List all the previously created statesets": { @@ -429,7 +429,7 @@ "get": { "x-publish": true, "operationId": "FeatureState_GetStatesPreview", - "description": ">[!Important]\n>The Azure Maps Creator services (Preview) version 1.0 will retire on 6 September 2021. Please transition to using version 2.0 by that date.\n>For details, see [Azure Maps Creator Tutorial](https://azure.microsoft.com/en-us/updates/azure-maps-creator-v1-will-be-retired-on-6-september-2021/).\n\n\n**Applies to**: see pricing [tiers](https://azure.microsoft.com/en-us/pricing/details/azure-maps/).
This API returns the current state information associated with the given feature in the given stateset.", + "description": ">[!Important]\n>The Azure Maps Creator services (Preview) version 1.0 will retire on 6 September 2021. Please transition to using version 2.0 by that date.\n>For details, see [Azure Maps Creator V1 Retirement](https://azure.microsoft.com/en-us/updates/azure-maps-creator-v1-will-be-retired-on-6-september-2021/).\n\n\n**Applies to**: see pricing [tiers](https://azure.microsoft.com/en-us/pricing/details/azure-maps/).
This API returns the current state information associated with the given feature in the given stateset.", "x-ms-examples": { "Get the current states of a feature": { "$ref": "./examples/GetStates.json" @@ -476,7 +476,7 @@ "post": { "x-publish": true, "operationId": "FeatureState_UpdateStatesPreview", - "description": ">[!Important]\n>The Azure Maps Creator services (Preview) version 1.0 will retire on 6 September 2021. Please transition to using version 2.0 by that date.\n>For details, see [Azure Maps Creator Tutorial](https://azure.microsoft.com/en-us/updates/azure-maps-creator-v1-will-be-retired-on-6-september-2021/).\n\n\n**Applies to**: see pricing [tiers](https://azure.microsoft.com/en-us/pricing/details/azure-maps/).
\nThis POST API allows the user to update the state of the given feature in the given stateset.", + "description": ">[!Important]\n>The Azure Maps Creator services (Preview) version 1.0 will retire on 6 September 2021. Please transition to using version 2.0 by that date.\n>For details, see [Azure Maps Creator V1 Retirement](https://azure.microsoft.com/en-us/updates/azure-maps-creator-v1-will-be-retired-on-6-september-2021/).\n\n\n**Applies to**: see pricing [tiers](https://azure.microsoft.com/en-us/pricing/details/azure-maps/).
\nThis POST API allows the user to update the state of the given feature in the given stateset.", "x-ms-examples": { "Update the states of a feature": { "$ref": "./examples/UpdateStates.json" @@ -529,7 +529,7 @@ "delete": { "x-publish": true, "operationId": "FeatureState_DeleteStatePreview", - "description": ">[!Important]\n>The Azure Maps Creator services (Preview) version 1.0 will retire on 6 September 2021. Please transition to using version 2.0 by that date.\n>For details, see [Azure Maps Creator Tutorial](https://azure.microsoft.com/en-us/updates/azure-maps-creator-v1-will-be-retired-on-6-september-2021/).\n\n\n**Applies to**: see pricing [tiers](https://azure.microsoft.com/en-us/pricing/details/azure-maps/).
This API deletes the state information identified by the StateKeyName parameter for the feature identified by the FeatureId parameter in the the stateset.", + "description": ">[!Important]\n>The Azure Maps Creator services (Preview) version 1.0 will retire on 6 September 2021. Please transition to using version 2.0 by that date.\n>For details, see [Azure Maps Creator V1 Retirement](https://azure.microsoft.com/en-us/updates/azure-maps-creator-v1-will-be-retired-on-6-september-2021/).\n\n\n**Applies to**: see pricing [tiers](https://azure.microsoft.com/en-us/pricing/details/azure-maps/).
This API deletes the state information identified by the StateKeyName parameter for the feature identified by the FeatureId parameter in the the stateset.", "x-ms-examples": { "Delete the given feature state": { "$ref": "./examples/DeleteFeatureState.json" diff --git a/specification/maps/data-plane/Microsoft.Maps/Tileset/preview/1.0/tileset.json b/specification/maps/data-plane/Microsoft.Maps/Tileset/preview/1.0/tileset.json index e1691619faf5..f194ce77bb42 100644 --- a/specification/maps/data-plane/Microsoft.Maps/Tileset/preview/1.0/tileset.json +++ b/specification/maps/data-plane/Microsoft.Maps/Tileset/preview/1.0/tileset.json @@ -207,7 +207,7 @@ "/tileset/create/vector": { "post": { "x-publish": true, - "description": ">[!Important]\n>The Azure Maps Creator services (Preview) version 1.0 will retire on 6 September 2021. Please transition to using version 2.0 by that date.\n>For details, see [Azure Maps Creator Tutorial](https://azure.microsoft.com/en-us/updates/azure-maps-creator-v1-will-be-retired-on-6-september-2021/).\n\n\n**Tileset Create API**\n\n**Applies to**: see pricing [tiers](https://azure.microsoft.com/en-us/pricing/details/azure-maps/).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API \nand SDK. [This](https://docs.microsoft.com/en-us/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThe Tileset Create API allows the caller to create a tileset from a dataset. A tileset contains a set of tiles that can be consumed \nfrom the [Get Map Tile](/rest/api/maps/render/getmaptile) to retrieve custom tiles. To make a dataset, use the \n[DataSet Create API](/rest/api/maps/dataset/createpreview).\n\n## Submit Create Request\n\nTo create your tileset you will make a `POST` request with an empty body. The `datasetId` query parameter will be \nused as the source of the tileset data.\n\nThe Create Tileset API is a \n[long-running request](https://aka.ms/am-creator-lrt).", + "description": ">[!Important]\n>The Azure Maps Creator services (Preview) version 1.0 will retire on 6 September 2021. Please transition to using version 2.0 by that date.\n>For details, see [Azure Maps Creator V1 Retirement](https://azure.microsoft.com/en-us/updates/azure-maps-creator-v1-will-be-retired-on-6-september-2021/).\n\n\n**Tileset Create API**\n\n**Applies to**: see pricing [tiers](https://azure.microsoft.com/en-us/pricing/details/azure-maps/).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API \nand SDK. [This](https://docs.microsoft.com/en-us/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThe Tileset Create API allows the caller to create a tileset from a dataset. A tileset contains a set of tiles that can be consumed \nfrom the [Get Map Tile](/rest/api/maps/render/getmaptile) to retrieve custom tiles. To make a dataset, use the \n[DataSet Create API](/rest/api/maps/dataset/createpreview).\n\n## Submit Create Request\n\nTo create your tileset you will make a `POST` request with an empty body. The `datasetId` query parameter will be \nused as the source of the tileset data.\n\nThe Create Tileset API is a \n[long-running request](https://aka.ms/am-creator-lrt).", "operationId": "Tileset_CreatePreview", "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { @@ -263,7 +263,7 @@ "/tileset": { "get": { "x-publish": true, - "description": ">[!Important]\n>The Azure Maps Creator services (Preview) version 1.0 will retire on 6 September 2021. Please transition to using version 2.0 by that date.\n>For details, see [Azure Maps Creator Tutorial](https://azure.microsoft.com/en-us/updates/azure-maps-creator-v1-will-be-retired-on-6-september-2021/).\n\n\n**Tileset List API**\n\n**Applies to**: see pricing [tiers](https://azure.microsoft.com/en-us/pricing/details/azure-maps/).\n
\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/en-us/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\nThis API allows the caller to fetch a list of all tilesets created. \n
", + "description": ">[!Important]\n>The Azure Maps Creator services (Preview) version 1.0 will retire on 6 September 2021. Please transition to using version 2.0 by that date.\n>For details, see [Azure Maps Creator V1 Retirement](https://azure.microsoft.com/en-us/updates/azure-maps-creator-v1-will-be-retired-on-6-september-2021/).\n\n\n**Tileset List API**\n\n**Applies to**: see pricing [tiers](https://azure.microsoft.com/en-us/pricing/details/azure-maps/).\n
\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/en-us/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\nThis API allows the caller to fetch a list of all tilesets created. \n
", "operationId": "Tileset_ListPreview", "x-ms-examples": { "Get a list of all tilesets": { @@ -309,7 +309,7 @@ "/tileset/{tilesetId}": { "delete": { "x-publish": true, - "description": ">[!Important]\n>The Azure Maps Creator services (Preview) version 1.0 will retire on 6 September 2021. Please transition to using version 2.0 by that date.\n>For details, see [Azure Maps Creator Tutorial](https://azure.microsoft.com/en-us/updates/azure-maps-creator-v1-will-be-retired-on-6-september-2021/).\n\n\n**Tileset Delete API**\n\n**Applies to**: see pricing [tiers](https://azure.microsoft.com/en-us/pricing/details/azure-maps/).\n
\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/en-us/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\nThis API allows the caller to delete a created tileset.
\nYou can use this API if a tileset is no longer needed. \n\n### Submit Delete Request\n\nTo delete your content you will issue a `DELETE` request where the path will contain the `tilesetId` of the tileset to delete.
\n\n#### Delete request \"Successful\"\n\nThe Tileset Delete API returns a HTTP `204 No Content` response with an empty body, if the tileset was deleted successfully.
\n\n#### Delete request \"Failed\"\n\nA HTTP `400 Bad Request` error response will be returned if the tileset with the passed-in `tilesetId` is not found. \n\nHere is a sample error response:\n\n
\n\n```json\n{\n \"error\": {\n \"code\": \"400 BadRequest\",\n \"message\": \"Bad request - Tileset Id: d85b5b27-5fc4-4599-8b50-47160e90f8ce does not exist.\"\n }\n}\n```", + "description": ">[!Important]\n>The Azure Maps Creator services (Preview) version 1.0 will retire on 6 September 2021. Please transition to using version 2.0 by that date.\n>For details, see [Azure Maps Creator V1 Retirement](https://azure.microsoft.com/en-us/updates/azure-maps-creator-v1-will-be-retired-on-6-september-2021/).\n\n\n**Tileset Delete API**\n\n**Applies to**: see pricing [tiers](https://azure.microsoft.com/en-us/pricing/details/azure-maps/).\n
\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/en-us/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\nThis API allows the caller to delete a created tileset.
\nYou can use this API if a tileset is no longer needed. \n\n### Submit Delete Request\n\nTo delete your content you will issue a `DELETE` request where the path will contain the `tilesetId` of the tileset to delete.
\n\n#### Delete request \"Successful\"\n\nThe Tileset Delete API returns a HTTP `204 No Content` response with an empty body, if the tileset was deleted successfully.
\n\n#### Delete request \"Failed\"\n\nA HTTP `400 Bad Request` error response will be returned if the tileset with the passed-in `tilesetId` is not found. \n\nHere is a sample error response:\n\n
\n\n```json\n{\n \"error\": {\n \"code\": \"400 BadRequest\",\n \"message\": \"Bad request - Tileset Id: d85b5b27-5fc4-4599-8b50-47160e90f8ce does not exist.\"\n }\n}\n```", "operationId": "Tileset_DeletePreview", "x-ms-examples": { "Delete a created tileset": { diff --git a/specification/maps/data-plane/Microsoft.Maps/WFS/preview/1.0/wfs.json b/specification/maps/data-plane/Microsoft.Maps/WFS/preview/1.0/wfs.json index a1d792c62b15..dfb4d2b6d180 100644 --- a/specification/maps/data-plane/Microsoft.Maps/WFS/preview/1.0/wfs.json +++ b/specification/maps/data-plane/Microsoft.Maps/WFS/preview/1.0/wfs.json @@ -200,7 +200,7 @@ "/wfs/datasets/{datasetid}/": { "get": { "x-publish": true, - "description": ">[!Important]\n>The Azure Maps Creator services (Preview) version 1.0 will retire on 6 September 2021. Please transition to using version 2.0 by that date.\n>For details, see [Azure Maps Creator Tutorial](https://azure.microsoft.com/en-us/updates/azure-maps-creator-v1-will-be-retired-on-6-september-2021/).\n\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. The Web Feature Service (WFS) API is part of Creator. WFS API follows the [Open Geospatial Consortium API standard for Features](http://docs.opengeospatial.org/is/17-069r3/17-069r3.html) to query [Datasets](https://docs.microsoft.com/en-us/rest/api/maps/dataset/createpreview). \nA dataset consists of multiple feature collections. A feature collection is a collection of features of a similar type, based on a common schema.\nThe Get Landing Page API provides links to the API definition, the Conformance statements and the metadata about the feature data in this dataset.", + "description": ">[!Important]\n>The Azure Maps Creator services (Preview) version 1.0 will retire on 6 September 2021. Please transition to using version 2.0 by that date.\n>For details, see [Azure Maps Creator V1 Retirement](https://azure.microsoft.com/en-us/updates/azure-maps-creator-v1-will-be-retired-on-6-september-2021/).\n\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. The Web Feature Service (WFS) API is part of Creator. WFS API follows the [Open Geospatial Consortium API standard for Features](http://docs.opengeospatial.org/is/17-069r3/17-069r3.html) to query [Datasets](https://docs.microsoft.com/en-us/rest/api/maps/dataset/createpreview). \nA dataset consists of multiple feature collections. A feature collection is a collection of features of a similar type, based on a common schema.\nThe Get Landing Page API provides links to the API definition, the Conformance statements and the metadata about the feature data in this dataset.", "operationId": "WFS_GetLandingPagePreview", "x-ms-examples": { "GetLandingPage": { @@ -248,7 +248,7 @@ }, "/wfs/datasets/{datasetid}/conformance": { "get": { - "description": ">[!Important]\n>The Azure Maps Creator services (Preview) version 1.0 will retire on 6 September 2021. Please transition to using version 2.0 by that date.\n>For details, see [Azure Maps Creator Tutorial](https://azure.microsoft.com/en-us/updates/azure-maps-creator-v1-will-be-retired-on-6-september-2021/).\n\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. The Web Feature Service (WFS) API is part of Creator. WFS API follows the [Open Geospatial Consortium API standard for Features](http://docs.opengeospatial.org/is/17-069r3/17-069r3.html) to query [Datasets](https://docs.microsoft.com/en-us/rest/api/maps/dataset/createpreview). \nA dataset consists of multiple feature collections. A feature collection is a collection of features of a similar type, based on a common schema.\nThe Get Requirements Classes lists all requirements classes specified in the standard that the server conforms to.", + "description": ">[!Important]\n>The Azure Maps Creator services (Preview) version 1.0 will retire on 6 September 2021. Please transition to using version 2.0 by that date.\n>For details, see [Azure Maps Creator V1 Retirement](https://azure.microsoft.com/en-us/updates/azure-maps-creator-v1-will-be-retired-on-6-september-2021/).\n\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. The Web Feature Service (WFS) API is part of Creator. WFS API follows the [Open Geospatial Consortium API standard for Features](http://docs.opengeospatial.org/is/17-069r3/17-069r3.html) to query [Datasets](https://docs.microsoft.com/en-us/rest/api/maps/dataset/createpreview). \nA dataset consists of multiple feature collections. A feature collection is a collection of features of a similar type, based on a common schema.\nThe Get Requirements Classes lists all requirements classes specified in the standard that the server conforms to.", "x-publish": true, "operationId": "WFS_GetRequirementsClassesPreview", "x-ms-examples": { @@ -297,7 +297,7 @@ }, "/wfs/datasets/{datasetid}/collections": { "get": { - "description": ">[!Important]\n>The Azure Maps Creator services (Preview) version 1.0 will retire on 6 September 2021. Please transition to using version 2.0 by that date.\n>For details, see [Azure Maps Creator Tutorial](https://azure.microsoft.com/en-us/updates/azure-maps-creator-v1-will-be-retired-on-6-september-2021/).\n\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. The Web Feature Service (WFS) API is part of Creator. WFS API follows the [Open Geospatial Consortium API standard for Features](http://docs.opengeospatial.org/is/17-069r3/17-069r3.html) to query [Datasets](https://docs.microsoft.com/en-us/rest/api/maps/dataset/createpreview). \nA dataset consists of multiple feature collections. A feature collection is a collection of features of a similar type, based on a common schema.\nThe Collections Description API provides descriptions of all the collections in a given dataset.", + "description": ">[!Important]\n>The Azure Maps Creator services (Preview) version 1.0 will retire on 6 September 2021. Please transition to using version 2.0 by that date.\n>For details, see [Azure Maps Creator V1 Retirement](https://azure.microsoft.com/en-us/updates/azure-maps-creator-v1-will-be-retired-on-6-september-2021/).\n\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. The Web Feature Service (WFS) API is part of Creator. WFS API follows the [Open Geospatial Consortium API standard for Features](http://docs.opengeospatial.org/is/17-069r3/17-069r3.html) to query [Datasets](https://docs.microsoft.com/en-us/rest/api/maps/dataset/createpreview). \nA dataset consists of multiple feature collections. A feature collection is a collection of features of a similar type, based on a common schema.\nThe Collections Description API provides descriptions of all the collections in a given dataset.", "operationId": "WFS_CollectionsDescriptionPreview", "x-publish": true, "x-ms-examples": { @@ -346,7 +346,7 @@ }, "/wfs/datasets/{datasetid}/collections/{collectionId}": { "get": { - "description": ">[!Important]\n>The Azure Maps Creator services (Preview) version 1.0 will retire on 6 September 2021. Please transition to using version 2.0 by that date.\n>For details, see [Azure Maps Creator Tutorial](https://azure.microsoft.com/en-us/updates/azure-maps-creator-v1-will-be-retired-on-6-september-2021/).\n\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. The Web Feature Service (WFS) API is part of Creator. WFS API follows the [Open Geospatial Consortium API standard for Features](http://docs.opengeospatial.org/is/17-069r3/17-069r3.html) to query [Datasets](https://docs.microsoft.com/en-us/rest/api/maps/dataset/createpreview). \nA dataset consists of multiple feature collections. A feature collection is a collection of features of a similar type, based on a common schema.\n \nThe Collection Description API provides the description of a given collection. It includes the links to the operations that can be performed on the collection.", + "description": ">[!Important]\n>The Azure Maps Creator services (Preview) version 1.0 will retire on 6 September 2021. Please transition to using version 2.0 by that date.\n>For details, see [Azure Maps Creator V1 Retirement](https://azure.microsoft.com/en-us/updates/azure-maps-creator-v1-will-be-retired-on-6-september-2021/).\n\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. The Web Feature Service (WFS) API is part of Creator. WFS API follows the [Open Geospatial Consortium API standard for Features](http://docs.opengeospatial.org/is/17-069r3/17-069r3.html) to query [Datasets](https://docs.microsoft.com/en-us/rest/api/maps/dataset/createpreview). \nA dataset consists of multiple feature collections. A feature collection is a collection of features of a similar type, based on a common schema.\n \nThe Collection Description API provides the description of a given collection. It includes the links to the operations that can be performed on the collection.", "operationId": "WFS_CollectionDescriptionPreview", "x-publish": true, "x-ms-examples": { @@ -398,7 +398,7 @@ }, "/wfs/datasets/{datasetid}/collections/{collectionId}/definition": { "get": { - "description": ">[!Important]\n>The Azure Maps Creator services (Preview) version 1.0 will retire on 6 September 2021. Please transition to using version 2.0 by that date.\n>For details, see [Azure Maps Creator Tutorial](https://azure.microsoft.com/en-us/updates/azure-maps-creator-v1-will-be-retired-on-6-september-2021/).\n\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. The Web Feature Service (WFS) API is part of Creator. WFS API follows the [Open Geospatial Consortium API standard for Features](http://docs.opengeospatial.org/is/17-069r3/17-069r3.html) to query [Datasets](https://docs.microsoft.com/en-us/rest/api/maps/dataset/createpreview). \nA dataset consists of multiple feature collections. A feature collection is a collection of features of a similar type, based on a common schema.\n \nThe Collection Definition API provides the detailed data model of a given collection.", + "description": ">[!Important]\n>The Azure Maps Creator services (Preview) version 1.0 will retire on 6 September 2021. Please transition to using version 2.0 by that date.\n>For details, see [Azure Maps Creator V1 Retirement](https://azure.microsoft.com/en-us/updates/azure-maps-creator-v1-will-be-retired-on-6-september-2021/).\n\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. The Web Feature Service (WFS) API is part of Creator. WFS API follows the [Open Geospatial Consortium API standard for Features](http://docs.opengeospatial.org/is/17-069r3/17-069r3.html) to query [Datasets](https://docs.microsoft.com/en-us/rest/api/maps/dataset/createpreview). \nA dataset consists of multiple feature collections. A feature collection is a collection of features of a similar type, based on a common schema.\n \nThe Collection Definition API provides the detailed data model of a given collection.", "operationId": "WFS_CollectionDefinitionPreview", "x-publish": true, "x-ms-examples": { @@ -450,7 +450,7 @@ }, "/wfs/datasets/{datasetid}/collections/{collectionId}/items": { "get": { - "description": ">[!Important]\n>The Azure Maps Creator services (Preview) version 1.0 will retire on 6 September 2021. Please transition to using version 2.0 by that date.\n>For details, see [Azure Maps Creator Tutorial](https://azure.microsoft.com/en-us/updates/azure-maps-creator-v1-will-be-retired-on-6-september-2021/).\n\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. The Web Feature Service (WFS) API is part of Creator. WFS API follows the [Open Geospatial Consortium API standard for Features](http://docs.opengeospatial.org/is/17-069r3/17-069r3.html) to query [Datasets](https://docs.microsoft.com/en-us/rest/api/maps/dataset/createpreview). \nA dataset consists of multiple feature collections. A feature collection is a collection of features of a similar type, based on a common schema.\nThe Get Features API returns the list of features in the given collection.", + "description": ">[!Important]\n>The Azure Maps Creator services (Preview) version 1.0 will retire on 6 September 2021. Please transition to using version 2.0 by that date.\n>For details, see [Azure Maps Creator V1 Retirement](https://azure.microsoft.com/en-us/updates/azure-maps-creator-v1-will-be-retired-on-6-september-2021/).\n\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. The Web Feature Service (WFS) API is part of Creator. WFS API follows the [Open Geospatial Consortium API standard for Features](http://docs.opengeospatial.org/is/17-069r3/17-069r3.html) to query [Datasets](https://docs.microsoft.com/en-us/rest/api/maps/dataset/createpreview). \nA dataset consists of multiple feature collections. A feature collection is a collection of features of a similar type, based on a common schema.\nThe Get Features API returns the list of features in the given collection.", "operationId": "WFS_GetFeaturesPreview", "x-publish": true, "x-ms-examples": { @@ -511,7 +511,7 @@ }, "/wfs/datasets/{datasetid}/collections/{collectionId}/items/{featureId}": { "get": { - "description": ">[!Important]\n>The Azure Maps Creator services (Preview) version 1.0 will retire on 6 September 2021. Please transition to using version 2.0 by that date.\n>For details, see [Azure Maps Creator Tutorial](https://azure.microsoft.com/en-us/updates/azure-maps-creator-v1-will-be-retired-on-6-september-2021/).\n\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. The Web Feature Service (WFS) API is part of Creator. WFS API follows the [Open Geospatial Consortium API standard for Features](http://docs.opengeospatial.org/is/17-069r3/17-069r3.html) to query [Datasets](https://docs.microsoft.com/en-us/rest/api/maps/dataset/createpreview). \nA dataset consists of multiple feature collections. A feature collection is a collection of features of a similar type, based on a common schema.\nThe Get Feature API returns the feature identified by the provided id in the given collection.", + "description": ">[!Important]\n>The Azure Maps Creator services (Preview) version 1.0 will retire on 6 September 2021. Please transition to using version 2.0 by that date.\n>For details, see [Azure Maps Creator V1 Retirement](https://azure.microsoft.com/en-us/updates/azure-maps-creator-v1-will-be-retired-on-6-september-2021/).\n\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. The Web Feature Service (WFS) API is part of Creator. WFS API follows the [Open Geospatial Consortium API standard for Features](http://docs.opengeospatial.org/is/17-069r3/17-069r3.html) to query [Datasets](https://docs.microsoft.com/en-us/rest/api/maps/dataset/createpreview). \nA dataset consists of multiple feature collections. A feature collection is a collection of features of a similar type, based on a common schema.\nThe Get Feature API returns the feature identified by the provided id in the given collection.", "x-publish": true, "operationId": "WFS_GetFeaturePreview", "x-ms-examples": { @@ -561,7 +561,7 @@ } }, "delete": { - "description": ">[!Important]\n>The Azure Maps Creator services (Preview) version 1.0 will retire on 6 September 2021. Please transition to using version 2.0 by that date.\n>For details, see [Azure Maps Creator Tutorial](https://azure.microsoft.com/en-us/updates/azure-maps-creator-v1-will-be-retired-on-6-september-2021/).\n\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. The Web Feature Service (WFS) API is part of Creator. WFS API follows the [Open Geospatial Consortium API standard for Features](http://docs.opengeospatial.org/is/17-069r3/17-069r3.html) to query [Datasets](https://docs.microsoft.com/en-us/rest/api/maps/dataset/createpreview). \nA dataset consists of multiple feature collections. A feature collection is a collection of features of a similar type, based on a common schema.\nThe Delete Feature API deletes the feature identified by the provided id in the given collection. At this point this API supports only facility features. Deleting a facility feature deletes all the child features of that facility recursively.", + "description": ">[!Important]\n>The Azure Maps Creator services (Preview) version 1.0 will retire on 6 September 2021. Please transition to using version 2.0 by that date.\n>For details, see [Azure Maps Creator V1 Retirement](https://azure.microsoft.com/en-us/updates/azure-maps-creator-v1-will-be-retired-on-6-september-2021/).\n\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. The Web Feature Service (WFS) API is part of Creator. WFS API follows the [Open Geospatial Consortium API standard for Features](http://docs.opengeospatial.org/is/17-069r3/17-069r3.html) to query [Datasets](https://docs.microsoft.com/en-us/rest/api/maps/dataset/createpreview). \nA dataset consists of multiple feature collections. A feature collection is a collection of features of a similar type, based on a common schema.\nThe Delete Feature API deletes the feature identified by the provided id in the given collection. At this point this API supports only facility features. Deleting a facility feature deletes all the child features of that facility recursively.", "x-publish": true, "operationId": "WFS_DeleteFeaturePreview", "x-ms-examples": { diff --git a/specification/maps/data-plane/Render/preview/2.0/render.json b/specification/maps/data-plane/Render/preview/2.0/render.json index 234fba73e523..80e8b03b3116 100644 --- a/specification/maps/data-plane/Render/preview/2.0/render.json +++ b/specification/maps/data-plane/Render/preview/2.0/render.json @@ -177,7 +177,8 @@ "name": "timeStamp", "in": "query", "description": "The desired date and time of the requested tile. This parameter must be specified in the standard date-time format (e.g. 2019-11-14T16:03:00-08:00), as defined by [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601). This parameter is only supported when tilesetId parameter is set to one of the values below.\n \n* microsoft.weather.infrared.main: We provide tiles up to 3 hours in the past. Tiles are available in 10-minute intervals. We round the timeStamp value to the nearest 10-minute time frame.\n* microsoft.weather.radar.main: We provide tiles up to 1.5 hours in the past and up to 2 hours in the future. Tiles are available in 5-minute intervals. We round the timeStamp value to the nearest 5-minute time frame.", - "type": "string" + "type": "string", + "format": "date-time" }, { "name": "tileSize", diff --git a/specification/maps/data-plane/Weather/preview/1.0/weather.json b/specification/maps/data-plane/Weather/preview/1.0/weather.json index 9e376ad9363f..6cbd62b09082 100644 --- a/specification/maps/data-plane/Weather/preview/1.0/weather.json +++ b/specification/maps/data-plane/Weather/preview/1.0/weather.json @@ -607,7 +607,8 @@ "properties": { "date": { "type": "string", - "description": "Date and time of the forecast in ISO 8601 format, for example, 2019-10-27T19:39:57-08:00." + "description": "Date and time of the forecast in ISO 8601 format, for example, 2019-10-27T19:39:57-08:00.", + "format": "date-time" }, "iconCode": { "type": "integer", @@ -794,6 +795,7 @@ "properties": { "startTime": { "type": "string", + "format": "date-time", "description": "The date and time for the start of the interval in ISO 8601 format, for example, 2019-10-27T19:39:57-08:00." }, "minute": { @@ -889,10 +891,11 @@ "properties": { "date": { "type": "string", - "description": "Date and time of the forecast in ISO 8601 format, for example, 2019-10-27T19:39:57-08:00." + "description": "Date of the forecast as example, 2019-10-27T00:00:00" }, "effectiveDate": { "type": "string", + "format": "date-time", "description": "Date and time of the beginning of the forecast quarter displayed in ISO 8601 format, for example, 2019-10-27T19:39:57-08:00." }, "quarter": { @@ -1137,6 +1140,7 @@ "properties": { "dateTime": { "type": "string", + "format": "date-time", "description": "Date and time of the current observation displayed in ISO 8601 format, for example, 2019-10-27T19:39:57-08:00." }, "phrase": { @@ -1248,10 +1252,12 @@ "properties": { "startDate": { "type": "string", + "format": "date-time", "description": "Date and time that the summary is in effect, displayed in ISO 8601 format, for example, 2019-10-27T19:39:57-08:00." }, "endDate": { "type": "string", + "format": "date-time", "description": "Date and time that the summary period ends, displayed in ISO 8601 format, for example, 2019-10-27T19:39:57-08:00." }, "severity": { @@ -1315,6 +1321,7 @@ "properties": { "date": { "type": "string", + "format": "date-time", "description": "Date and time of the current observation displayed in ISO 8601 format, for example, 2019-10-27T19:39:57-08:00." }, "temperature": { @@ -1771,10 +1778,12 @@ }, "startTime": { "type": "string", + "format": "date-time", "description": "The start date and time of the alert in ISO 8601 format, for example, 2019-10-27T19:39:57-08:00. If the alert crosses multiple time zones the returned time in the response is the local time to the requested coordinate location." }, "endTime": { "type": "string", + "format": "date-time", "description": "The end date and time of the alert in ISO 8601 format, for example, 2019-10-27T19:39:57-08:00. If the alert crosses multiple time zones the returned time in the response is the local time to the requested coordinate location." }, "latestStatus": { @@ -1885,6 +1894,7 @@ }, "dateTime": { "type": "string", + "format": "date-time", "description": "Date and time of the current observation displayed in ISO 8601 format, for example, 2019-10-27T19:39:57-08:00." }, "value": { diff --git a/specification/marketplaceordering/resource-manager/Microsoft.MarketplaceOrdering/stable/2015-06-01/Agreements.json b/specification/marketplaceordering/resource-manager/Microsoft.MarketplaceOrdering/stable/2015-06-01/Agreements.json index 5cff9c5eb3d4..2566c843184b 100644 --- a/specification/marketplaceordering/resource-manager/Microsoft.MarketplaceOrdering/stable/2015-06-01/Agreements.json +++ b/specification/marketplaceordering/resource-manager/Microsoft.MarketplaceOrdering/stable/2015-06-01/Agreements.json @@ -70,6 +70,13 @@ "$ref": "#/definitions/AgreementTerms" } }, + "415": { + "description": "Unsupported Media Type", + "x-ms-error-response": true, + "schema": { + "$ref": "#/definitions/UnsupportedMediaTypeErrorResponse" + } + }, "default": { "description": "Microsoft.MarketplaceOrdering error response describing why the operation failed.", "schema": { @@ -122,6 +129,13 @@ "$ref": "#/definitions/AgreementTerms" } }, + "415": { + "description": "Unsupported Media Type", + "x-ms-error-response": true, + "schema": { + "$ref": "#/definitions/UnsupportedMediaTypeErrorResponse" + } + }, "default": { "description": "Microsoft.MarketplaceOrdering error response describing why the operation failed.", "schema": { @@ -150,6 +164,13 @@ "$ref": "#/definitions/OperationListResult" } }, + "415": { + "description": "Unsupported Media Type", + "x-ms-error-response": true, + "schema": { + "$ref": "#/definitions/UnsupportedMediaTypeErrorResponse" + } + }, "default": { "description": "Microsoft.MarketplaceOrdering error response describing why the operation failed.", "schema": { @@ -195,6 +216,13 @@ "$ref": "#/definitions/OldAgreementTerms" } }, + "415": { + "description": "Unsupported Media Type", + "x-ms-error-response": true, + "schema": { + "$ref": "#/definitions/UnsupportedMediaTypeErrorResponse" + } + }, "default": { "description": "Microsoft.MarketplaceOrdering error response describing why the operation failed.", "schema": { @@ -237,6 +265,13 @@ "$ref": "#/definitions/OldAgreementTerms" } }, + "415": { + "description": "Unsupported Media Type", + "x-ms-error-response": true, + "schema": { + "$ref": "#/definitions/UnsupportedMediaTypeErrorResponse" + } + }, "default": { "description": "Microsoft.MarketplaceOrdering error response describing why the operation failed.", "schema": { @@ -279,6 +314,13 @@ "$ref": "#/definitions/OldAgreementTerms" } }, + "415": { + "description": "Unsupported Media Type", + "x-ms-error-response": true, + "schema": { + "$ref": "#/definitions/UnsupportedMediaTypeErrorResponse" + } + }, "default": { "description": "Microsoft.MarketplaceOrdering error response describing why the operation failed.", "schema": { @@ -312,6 +354,13 @@ "$ref": "#/definitions/AgreementTermsList" } }, + "415": { + "description": "Unsupported Media Type", + "x-ms-error-response": true, + "schema": { + "$ref": "#/definitions/UnsupportedMediaTypeErrorResponse" + } + }, "default": { "description": "Microsoft.MarketplaceOrdering error response describing why the operation failed.", "schema": { @@ -386,12 +435,13 @@ "description": "The value of the array.", "type": "array", "items": { - "$ref": "#/definitions/AgreementTerms" + "$ref": "#/definitions/OldAgreementTerms" } } } }, "AgreementTerms": { + "type": "object", "properties": { "properties": { "$ref": "#/definitions/AgreementProperties", @@ -407,6 +457,7 @@ "description": "Terms properties for provided Publisher/Offer/Plan tuple" }, "AgreementProperties": { + "type": "object", "properties": { "publisher": { "type": "string", @@ -500,20 +551,30 @@ }, "description": "Old Agreement Terms definition" }, + "UnsupportedMediaTypeErrorResponse": { + "description": "Error response that indicates the media type in the request is unsupported.", + "type": "object", + "properties": { + "Message": { + "type": "string", + "description": "The details of the error." + } + } + }, "ErrorResponse": { "description": "Error response indicates Microsoft.MarketplaceOrdering service is not able to process the incoming request. The reason is provided in the error message.", "type": "object", "properties": { - "Error": { + "error": { "type": "object", "description": "The details of the error.", "properties": { - "Code": { + "code": { "description": "Error code.", "type": "string", "readOnly": true }, - "Message": { + "message": { "description": "Error message indicating why the operation failed.", "type": "string", "readOnly": true @@ -532,6 +593,7 @@ }, "display": { "description": "The object that represents the operation.", + "type": "object", "properties": { "provider": { "description": "Service provider: Microsoft.MarketplaceOrdering", @@ -555,9 +617,11 @@ }, "OperationListResult": { "description": "Result of the request to list MarketplaceOrdering operations. It contains a list of operations and a URL link to get the next set of results.", + "type": "object", "properties": { "value": { "type": "array", + "uniqueItems": false, "items": { "$ref": "#/definitions/Operation" }, @@ -572,6 +636,7 @@ }, "Resource": { "description": "ARM resource.", + "type": "object", "properties": { "id": { "readOnly": true, diff --git a/specification/marketplaceordering/resource-manager/Microsoft.MarketplaceOrdering/stable/2015-06-01/examples/CancelMarketplaceTerms.json b/specification/marketplaceordering/resource-manager/Microsoft.MarketplaceOrdering/stable/2015-06-01/examples/CancelMarketplaceTerms.json index d6de9dfb7201..e45b6c83751b 100644 --- a/specification/marketplaceordering/resource-manager/Microsoft.MarketplaceOrdering/stable/2015-06-01/examples/CancelMarketplaceTerms.json +++ b/specification/marketplaceordering/resource-manager/Microsoft.MarketplaceOrdering/stable/2015-06-01/examples/CancelMarketplaceTerms.json @@ -21,6 +21,11 @@ "state": "Canceled" } } + }, + "415": { + "body": { + "Message": "media type unsupported" + } } } } diff --git a/specification/marketplaceordering/resource-manager/Microsoft.MarketplaceOrdering/stable/2015-06-01/examples/GetAgreementMarketplaceTerms.json b/specification/marketplaceordering/resource-manager/Microsoft.MarketplaceOrdering/stable/2015-06-01/examples/GetAgreementMarketplaceTerms.json index d6de9dfb7201..e45b6c83751b 100644 --- a/specification/marketplaceordering/resource-manager/Microsoft.MarketplaceOrdering/stable/2015-06-01/examples/GetAgreementMarketplaceTerms.json +++ b/specification/marketplaceordering/resource-manager/Microsoft.MarketplaceOrdering/stable/2015-06-01/examples/GetAgreementMarketplaceTerms.json @@ -21,6 +21,11 @@ "state": "Canceled" } } + }, + "415": { + "body": { + "Message": "media type unsupported" + } } } } diff --git a/specification/marketplaceordering/resource-manager/Microsoft.MarketplaceOrdering/stable/2015-06-01/examples/GetMarketplaceTerms.json b/specification/marketplaceordering/resource-manager/Microsoft.MarketplaceOrdering/stable/2015-06-01/examples/GetMarketplaceTerms.json index 1c8b01a0329a..95b51e760a59 100644 --- a/specification/marketplaceordering/resource-manager/Microsoft.MarketplaceOrdering/stable/2015-06-01/examples/GetMarketplaceTerms.json +++ b/specification/marketplaceordering/resource-manager/Microsoft.MarketplaceOrdering/stable/2015-06-01/examples/GetMarketplaceTerms.json @@ -24,6 +24,11 @@ "accepted": true } } + }, + "415": { + "body": { + "Message": "media type unsupported" + } } } } diff --git a/specification/marketplaceordering/resource-manager/Microsoft.MarketplaceOrdering/stable/2015-06-01/examples/ListMarketplaceTerms.json b/specification/marketplaceordering/resource-manager/Microsoft.MarketplaceOrdering/stable/2015-06-01/examples/ListMarketplaceTerms.json index 8e51d7f75001..2e5c80bf94bc 100644 --- a/specification/marketplaceordering/resource-manager/Microsoft.MarketplaceOrdering/stable/2015-06-01/examples/ListMarketplaceTerms.json +++ b/specification/marketplaceordering/resource-manager/Microsoft.MarketplaceOrdering/stable/2015-06-01/examples/ListMarketplaceTerms.json @@ -13,17 +13,19 @@ "type": "Microsoft.MarketplaceOrdering/offertypes", "properties": { "publisher": "pubid", - "product": "offid", - "plan": "planid", - "licenseTextLink": "test.licenseLink", - "privacyPolicyLink": "test.privacyPolicyLink", - "retrieveDatetime": "2017-08-15T11:33:07.12132Z", - "signature": "ASDFSDAFWEFASDGWERLWER", - "accepted": true + "offer": "offid", + "signDate": "2019-04-26T05:57:25.3013164Z", + "cancelDate": "2019-04-27T05:57:25.3013164Z", + "state": "Active" } } ] } + }, + "415": { + "body": { + "Message": "media type unsupported" + } } } } diff --git a/specification/marketplaceordering/resource-manager/Microsoft.MarketplaceOrdering/stable/2015-06-01/examples/SetMarketplaceTerms.json b/specification/marketplaceordering/resource-manager/Microsoft.MarketplaceOrdering/stable/2015-06-01/examples/SetMarketplaceTerms.json index cc1cbbdbb02e..2a12ce8d3143 100644 --- a/specification/marketplaceordering/resource-manager/Microsoft.MarketplaceOrdering/stable/2015-06-01/examples/SetMarketplaceTerms.json +++ b/specification/marketplaceordering/resource-manager/Microsoft.MarketplaceOrdering/stable/2015-06-01/examples/SetMarketplaceTerms.json @@ -37,6 +37,11 @@ "accepted": true } } + }, + "415": { + "body": { + "Message": "media type unsupported" + } } } } diff --git a/specification/marketplaceordering/resource-manager/Microsoft.MarketplaceOrdering/stable/2015-06-01/examples/SignMarketplaceTerms.json b/specification/marketplaceordering/resource-manager/Microsoft.MarketplaceOrdering/stable/2015-06-01/examples/SignMarketplaceTerms.json index d6de9dfb7201..e45b6c83751b 100644 --- a/specification/marketplaceordering/resource-manager/Microsoft.MarketplaceOrdering/stable/2015-06-01/examples/SignMarketplaceTerms.json +++ b/specification/marketplaceordering/resource-manager/Microsoft.MarketplaceOrdering/stable/2015-06-01/examples/SignMarketplaceTerms.json @@ -21,6 +21,11 @@ "state": "Canceled" } } + }, + "415": { + "body": { + "Message": "media type unsupported" + } } } } diff --git a/specification/marketplaceordering/resource-manager/readme.md b/specification/marketplaceordering/resource-manager/readme.md index 97a75484d98f..1ec1afdcc45e 100644 --- a/specification/marketplaceordering/resource-manager/readme.md +++ b/specification/marketplaceordering/resource-manager/readme.md @@ -67,6 +67,11 @@ These settings apply only when `--tag=package-2015-06-01` is specified on the co ``` yaml $(tag) == 'package-2015-06-01' input-file: - Microsoft.MarketplaceOrdering/stable/2015-06-01/Agreements.json +directive: + # suppress each RPC 3016 error +- where: $.definitions.UnsupportedMediaTypeErrorResponse.properties.Message + suppress: R3016 + reason: This requires a change in code thats in production for several years ``` diff --git a/specification/monitor/resource-manager/readme.go.md b/specification/monitor/resource-manager/readme.go.md index 8feeda379f3e..2cf5467d3de0 100644 --- a/specification/monitor/resource-manager/readme.go.md +++ b/specification/monitor/resource-manager/readme.go.md @@ -38,7 +38,7 @@ batch: - tag: package-2019-06 - tag: package-2019-11 - tag: package-2020-10-only - - tag: package-2021-04 + - tag: package-2021-07 ``` ### Tag: package-2017-09 and go @@ -113,13 +113,13 @@ Please also specify `--go-sdk-folder=`. -``` yaml $(tag) == 'package-2021-04' && $(go) -output-folder: $(go-sdk-folder)/services/preview/monitor/mgmt/2021-04-01-preview/$(namespace) +``` yaml $(tag) == 'package-2021-07' && $(go) +output-folder: $(go-sdk-folder)/services/preview/monitor/mgmt/2021-07-01-preview/$(namespace) directive: - from: activityLogAlerts_API.json where: $.parameters diff --git a/specification/monitor/resource-manager/readme.md b/specification/monitor/resource-manager/readme.md index 064cdc336f0c..626c2bb08d37 100644 --- a/specification/monitor/resource-manager/readme.md +++ b/specification/monitor/resource-manager/readme.md @@ -35,7 +35,38 @@ title: MonitorManagementClient ``` yaml description: Monitor Management Client openapi-type: arm -tag: package-2021-04 +tag: package-2021-07 +``` + +### Tag: package-2021-07 + +These settings apply only when `--tag=package-2021-07` is specified on the command line + +``` yaml $(tag) == 'package-2021-07' +input-file: +- Microsoft.Insights/stable/2015-04-01/autoscale_API.json +- Microsoft.Insights/stable/2015-04-01/operations_API.json +- Microsoft.Insights/stable/2016-03-01/alertRulesIncidents_API.json +- Microsoft.Insights/stable/2016-03-01/alertRules_API.json +- Microsoft.Insights/stable/2016-03-01/logProfiles_API.json +- Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettings_API.json +- Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettingsCategories_API.json +- Microsoft.Insights/stable/2019-06-01/actionGroups_API.json +- Microsoft.Insights/stable/2015-04-01/activityLogs_API.json +- Microsoft.Insights/stable/2015-04-01/eventCategories_API.json +- Microsoft.Insights/stable/2015-04-01/tenantActivityLogs_API.json +- Microsoft.Insights/stable/2018-01-01/metricDefinitions_API.json +- Microsoft.Insights/stable/2018-01-01/metrics_API.json +- Microsoft.Insights/stable/2019-03-01/metricBaselines_API.json +- Microsoft.Insights/stable/2018-03-01/metricAlert_API.json +- Microsoft.Insights/stable/2018-04-16/scheduledQueryRule_API.json +- Microsoft.Insights/preview/2017-12-01-preview/metricNamespaces_API.json +- Microsoft.Insights/preview/2018-11-27-preview/vmInsightsOnboarding_API.json +- Microsoft.Insights/preview/2019-10-17-preview/privateLinkScopes_API.json +- Microsoft.Insights/stable/2020-10-01/activityLogAlerts_API.json +- Microsoft.Insights/stable/2021-04-01/dataCollectionEndpoints_API.json +- Microsoft.Insights/stable/2021-04-01/dataCollectionRuleAssociations_API.json +- Microsoft.Insights/stable/2021-04-01/dataCollectionRules_API.json ``` ### Tag: package-2021-04 @@ -756,18 +787,30 @@ directive: from: autoscale_API.json where: $.paths reason: 'Operations API is defined in a separate swagger spec for Microsoft.Insights namespace (https://github.com/Azure/azure-rest-api-specs/blob/master/specification/monitor/resource-manager/Microsoft.Insights/stable/2015-04-01/operations_API.json)' - + ``` -``` yaml ($(go) && !$(track2)) || $(csharp) || $(validation) || $(typescript) +``` yaml ($(go) && !$(track2) && $(tag) == 'package-2021-07') || $(csharp) || $(validation) || $(typescript) directive: - from: activityLogAlerts_API.json where: $.definitions transform: delete $["Resource"] reason: Missing kind, etag +- from: activityLogAlerts_API.json + where: $.definitions + transform: delete $["ErrorResponse"] + reason: Incompatible values (2020-10-01) +- from: activityLogAlerts_API.json + where: $.definitions + transform: delete $["AzureResource"] + reason: Incompatible values (2020-10-01) +- from: activityLogAlerts_API.json + where: $.definitions + transform: delete $["ActionGroup"] + reason: Incompatible values (2020-10-01) ``` -``` yaml !$(python) && !$(go) && !$(java) && $(tag) == 'package-2021-04' +``` yaml !$(python) && !$(go) && !$(java) && ($(tag) == 'package-2021-04' || $(tag) == 'package-2021-07') directive: - from: scheduledQueryRule_API.json where: $.parameters @@ -814,7 +857,7 @@ directive: ### Tag: profile-hybrid-2019-03-01 These settings apply only when `--tag=profile-hybrid-2019-03-01` is specified on the command line. -Creating this tag to pick proper resources from the hybrid profile. +Creating this tag to pick proper resources from the hybrid profile. ``` yaml $(tag) == 'profile-hybrid-2019-03-01' input-file: diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ServerCreate.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ServerCreate.json index ce333211ec73..d1a8a6ac4f47 100644 --- a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ServerCreate.json +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ServerCreate.json @@ -23,7 +23,8 @@ }, "storageProfile": { "storageMB": 524288, - "backupRetentionDays": 7 + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled" }, "availabilityZone": "1" }, @@ -42,12 +43,15 @@ "properties": { "administratorLogin": "cloudsa", "version": "12", + "minorVersion": "6", "state": "Ready", "haState": "NotEnabled", "fullyQualifiedDomainName": "pgtestsvc4.postgres.database.azure.com", "displayName": "demosingleserver", "publicNetworkAccess": "Enabled", "haEnabled": "Enabled", + "standbyCount": 1, + "logBackupStorageSku": "Standard_ZRS", "delegatedSubnetArguments": { "subnetArmResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-vnet-subnet" }, @@ -56,7 +60,9 @@ }, "storageProfile": { "storageMB": 524288, - "backupRetentionDays": 7 + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-05-26T23:07:25.8166567+00:00" }, "availabilityZone": "1", "standbyAvailabilityZone": "2", @@ -85,12 +91,15 @@ "properties": { "administratorLogin": "cloudsa", "version": "12", + "minorVersion": "6", "state": "Ready", "haState": "NotEnabled", "fullyQualifiedDomainName": "pgtestsvc4.postgres.database.azure.com", "displayName": "demosingleserver", "publicNetworkAccess": "Enabled", "haEnabled": "Enabled", + "standbyCount": 1, + "logBackupStorageSku": "Standard_ZRS", "delegatedSubnetArguments": { "subnetArmResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-vnet-subnet" }, @@ -99,7 +108,9 @@ }, "storageProfile": { "storageMB": 524288, - "backupRetentionDays": 7 + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-05-26T23:07:25.8166567+00:00" }, "availabilityZone": "1", "standbyAvailabilityZone": "2", diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ServerCreatePointInTimeRestore.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ServerCreatePointInTimeRestore.json index 4c902f67f91c..d3099cf93649 100644 --- a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ServerCreatePointInTimeRestore.json +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ServerCreatePointInTimeRestore.json @@ -25,17 +25,22 @@ "properties": { "administratorLogin": "cloudsa", "version": "12", + "minorVersion": "6", "state": "Ready", "haState": "NotEnabled", "fullyQualifiedDomainName": "pgtestsvc4.postgres.database.azure.com", "displayName": "demosingleserver", "publicNetworkAccess": "Enabled", "haEnabled": "Disabled", + "standbyCount": 0, + "logBackupStorageSku": "Standard_ZRS", "delegatedSubnetArguments": {}, "privateDnsZoneArguments": {}, "storageProfile": { "storageMB": 524288, - "backupRetentionDays": 7 + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-05-26T23:07:25.8166567+00:00" }, "availabilityZone": "1" }, @@ -57,17 +62,22 @@ "properties": { "administratorLogin": "cloudsa", "version": "12", + "minorVersion": "6", "state": "Ready", "haState": "NotEnabled", "fullyQualifiedDomainName": "pgtestsvc4.postgres.database.azure.com", "displayName": "demosingleserver", "publicNetworkAccess": "Enabled", "haEnabled": "Disabled", + "standbyCount": 0, + "logBackupStorageSku": "Standard_ZRS", "delegatedSubnetArguments": {}, "privateDnsZoneArguments": {}, "storageProfile": { "storageMB": 524288, - "backupRetentionDays": 7 + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-05-26T23:07:25.8166567+00:00" }, "availabilityZone": "1" }, diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ServerGet.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ServerGet.json index b28535f615a1..49b06b0c9626 100644 --- a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ServerGet.json +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ServerGet.json @@ -15,6 +15,7 @@ "properties": { "administratorLogin": "cloudsa", "version": "12", + "minorVersion": "6", "state": "Ready", "haState": "NotEnabled", "fullyQualifiedDomainName": "pgtestsvc4.postgres.database.azure.com", @@ -22,9 +23,13 @@ "publicNetworkAccess": "Enabled", "storageProfile": { "storageMB": 524288, - "backupRetentionDays": 7 + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-05-26T23:07:25.8166567+00:00" }, "haEnabled": "Enabled", + "standbyCount": 1, + "logBackupStorageSku": "Standard_ZRS", "availabilityZone": "1", "standbyAvailabilityZone": "2", "maintenanceWindow": { diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ServerGetWithVnet.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ServerGetWithVnet.json index 13126f937fcc..c66b083767e8 100644 --- a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ServerGetWithVnet.json +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ServerGetWithVnet.json @@ -15,8 +15,12 @@ "properties": { "administratorLogin": "cloudsa", "version": "12", + "minorVersion": "6", "state": "Ready", "haState": "NotEnabled", + "haEnabled": "Disabled", + "standbyCount": 0, + "logBackupStorageSku": "Standard_ZRS", "fullyQualifiedDomainName": "pgtestsvc4.postgres.database.azure.com", "displayName": "demosingleserver", "publicNetworkAccess": "Disabled", @@ -28,7 +32,9 @@ }, "storageProfile": { "storageMB": 524288, - "backupRetentionDays": 7 + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-05-26T23:07:25.8166567+00:00" }, "availabilityZone": "1" }, diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ServerList.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ServerList.json index d8917699f069..39feb87e4930 100644 --- a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ServerList.json +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ServerList.json @@ -16,6 +16,7 @@ "properties": { "administratorLogin": "cloudsa", "version": "12", + "minorVersion": "6", "state": "Ready", "haState": "NotEnabled", "fullyQualifiedDomainName": "pgtestsvc1.postgres.database.azure.com", @@ -23,9 +24,13 @@ "publicNetworkAccess": "Enabled", "storageProfile": { "storageMB": 524288, - "backupRetentionDays": 7 + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-05-26T23:07:25.8166567+00:00" }, "haEnabled": "Enabled", + "standbyCount": 1, + "logBackupStorageSku": "Standard_ZRS", "availabilityZone": "1", "standbyAvailabilityZone": "2", "maintenanceWindow": { @@ -51,6 +56,7 @@ "properties": { "administratorLogin": "cloudsa", "version": "12", + "minorVersion": "6", "state": "Ready", "haState": "Healthy", "fullyQualifiedDomainName": "pgtestsvc2.postgres.database.azure.com", @@ -58,9 +64,13 @@ "publicNetworkAccess": "Enabled", "storageProfile": { "storageMB": 524288, - "backupRetentionDays": 7 + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-05-26T23:07:25.8166567+00:00" }, "haEnabled": "Disabled", + "standbyCount": 0, + "logBackupStorageSku": "Standard_ZRS", "availabilityZone": "2", "maintenanceWindow": { "dayOfWeek": 0, @@ -85,6 +95,7 @@ "properties": { "administratorLogin": "cloudsa", "version": "12", + "minorVersion": "6", "state": "Ready", "haState": "FailingOver", "fullyQualifiedDomainName": "pgtestsvc3.postgres.database.azure.com", @@ -92,9 +103,13 @@ "publicNetworkAccess": "Enabled", "storageProfile": { "storageMB": 524288, - "backupRetentionDays": 7 + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-05-26T23:07:25.8166567+00:00" }, "haEnabled": "Disabled", + "standbyCount": 0, + "logBackupStorageSku": "Standard_ZRS", "availabilityZone": "3", "maintenanceWindow": { "dayOfWeek": 0, @@ -119,6 +134,7 @@ "properties": { "administratorLogin": "cloudsa", "version": "12", + "minorVersion": "6", "state": "Ready", "haState": "ReplicatingData", "fullyQualifiedDomainName": "pgtestsvc4.postgres.database.azure.com", @@ -126,9 +142,13 @@ "publicNetworkAccess": "Enabled", "storageProfile": { "storageMB": 524288, - "backupRetentionDays": 7 + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-05-26T23:07:25.8166567+00:00" }, "haEnabled": "Enabled", + "standbyCount": 1, + "logBackupStorageSku": "Standard_ZRS", "availabilityZone": "1", "standbyAvailabilityZone": "2", "maintenanceWindow": { diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ServerListByResourceGroup.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ServerListByResourceGroup.json index 276e20cb04d8..1e59f192b218 100644 --- a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ServerListByResourceGroup.json +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ServerListByResourceGroup.json @@ -17,6 +17,7 @@ "properties": { "administratorLogin": "testuser", "version": "12", + "minorVersion": "6", "state": "Ready", "haState": "NotEnabled", "fullyQualifiedDomainName": "pgtestsvc4.postgres.database.azure.com", @@ -24,9 +25,13 @@ "publicNetworkAccess": "Enabled", "storageProfile": { "storageMB": 524288, - "backupRetentionDays": 7 + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-05-26T23:07:25.8166567+00:00" }, "haEnabled": "Enabled", + "standbyCount": 1, + "logBackupStorageSku": "Standard_ZRS", "availabilityZone": "1", "standbyAvailabilityZone": "2", "maintenanceWindow": { @@ -49,6 +54,7 @@ "properties": { "administratorLogin": "testuser", "version": "12", + "minorVersion": "6", "state": "Ready", "haState": "Healthy", "fullyQualifiedDomainName": "pgtestsvc4.postgres.database.azure.com", @@ -56,9 +62,13 @@ "publicNetworkAccess": "Enabled", "storageProfile": { "storageMB": 524288, - "backupRetentionDays": 7 + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-05-26T23:07:25.8166567+00:00" }, "haEnabled": "Disabled", + "standbyCount": 0, + "logBackupStorageSku": "Standard_ZRS", "availabilityZone": "2", "maintenanceWindow": { "dayOfWeek": 0, @@ -80,6 +90,7 @@ "properties": { "administratorLogin": "testuser", "version": "12", + "minorVersion": "6", "state": "Ready", "haState": "Healthy", "fullyQualifiedDomainName": "pgtestsvc4.postgres.database.azure.com", @@ -87,9 +98,13 @@ "publicNetworkAccess": "Enabled", "storageProfile": { "storageMB": 524288, - "backupRetentionDays": 7 + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-05-26T23:07:25.8166567+00:00" }, "haEnabled": "Disabled", + "standbyCount": 0, + "logBackupStorageSku": "Standard_ZRS", "availabilityZone": "3", "maintenanceWindow": { "dayOfWeek": 0, diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ServerUpdate.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ServerUpdate.json index 60c9bb9ae82a..ebcb79ed0800 100644 --- a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ServerUpdate.json +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ServerUpdate.json @@ -29,6 +29,7 @@ "properties": { "administratorLogin": "cloudsa", "version": "12", + "minorVersion": "6", "state": "Ready", "haState": "NotEnabled", "fullyQualifiedDomainName": "pgtestsvc4.postgres.database.azure.com", @@ -36,11 +37,15 @@ "publicNetworkAccess": "Enabled", "storageProfile": { "storageMB": 524288, - "backupRetentionDays": 20 + "backupRetentionDays": 20, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-05-26T23:07:25.8166567+00:00" }, "delegatedSubnetArguments": {}, "privateDnsZoneArguments": {}, "haEnabled": "Disabled", + "standbyCount": 0, + "logBackupStorageSku": "Standard_ZRS", "availabilityZone": "1" }, "location": "westus", diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ServerUpdateWithCustomerMaintenanceWindow.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ServerUpdateWithCustomerMaintenanceWindow.json index 26e2330fffcd..034dbc34e0f7 100644 --- a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ServerUpdateWithCustomerMaintenanceWindow.json +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ServerUpdateWithCustomerMaintenanceWindow.json @@ -26,6 +26,7 @@ "properties": { "administratorLogin": "cloudsa", "version": "12", + "minorVersion": "6", "state": "Ready", "haState": "NotEnabled", "fullyQualifiedDomainName": "pgtestsvc4.postgres.database.azure.com", @@ -33,11 +34,15 @@ "publicNetworkAccess": "Enabled", "storageProfile": { "storageMB": 524288, - "backupRetentionDays": 20 + "backupRetentionDays": 20, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-05-26T23:07:25.8166567+00:00" }, "delegatedSubnetArguments": {}, "privateDnsZoneArguments": {}, "haEnabled": "Disabled", + "standbyCount": 0, + "logBackupStorageSku": "Standard_ZRS", "availabilityZone": "1", "maintenanceWindow": { "dayOfWeek": 0, diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/postgresql.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/postgresql.json index 6cb9ac4eb47d..2f9d84b9b974 100644 --- a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/postgresql.json +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/postgresql.json @@ -1189,6 +1189,11 @@ "$ref": "#/definitions/ServerVersion", "description": "PostgreSQL Server version." }, + "minorVersion": { + "type": "string", + "description": "The minor version of the server.", + "readOnly": true + }, "state": { "type": "string", "description": "A state of a server that is visible to user.", @@ -1252,7 +1257,11 @@ }, "maintenanceWindow": { "$ref": "#/definitions/MaintenanceWindow", - "description": "Maintenance window of a server." + "description": "Maintenance window of a server.", + "x-ms-mutability": [ + "update", + "read" + ] }, "haEnabled": { "type": "string", @@ -1266,6 +1275,23 @@ "modelAsString": false } }, + "standbyCount": { + "type": "integer", + "format": "int32", + "description": "The number of standbys.", + "x-ms-mutability": [ + "update", + "read" + ] + }, + "logBackupStorageSku": { + "type": "string", + "description": "The log backup storage sku of the server.", + "x-ms-mutability": [ + "create", + "read" + ] + }, "sourceServerName": { "type": "string", "description": "The source PostgreSQL server name to restore from." @@ -1285,7 +1311,11 @@ }, "availabilityZone": { "type": "string", - "description": "availability Zone information of the server." + "description": "availability Zone information of the server.", + "x-ms-mutability": [ + "create", + "read" + ] }, "standbyAvailabilityZone": { "type": "string", @@ -1409,9 +1439,22 @@ "modelAsString": false } }, + "standbyCount": { + "type": "integer", + "format": "int32", + "description": "The number of standbys.", + "x-ms-mutability": [ + "update", + "read" + ] + }, "maintenanceWindow": { "$ref": "#/definitions/MaintenanceWindow", - "description": "Maintenance window of a server." + "description": "Maintenance window of a server.", + "x-ms-mutability": [ + "update", + "read" + ] } } }, @@ -1468,6 +1511,28 @@ "type": "integer", "format": "int32", "description": "Max storage allowed for a server." + }, + "geoRedundantBackup": { + "type": "string", + "description": "A value indicating whether Geo-Redundant backup is enabled on the server.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "GeoRedundantBackupEnum", + "modelAsString": true + }, + "x-ms-mutability": [ + "create", + "read" + ] + }, + "earliestRestoreDate": { + "type": "string", + "format": "date-time", + "description": "The earliest restore point time (ISO8601 format) for server.", + "readOnly": true } }, "description": "Storage Profile properties of a server" diff --git a/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/CustomRollouts_CreateOrUpdate.json b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/CustomRollouts_CreateOrUpdate.json index 7e80830891c5..4e84f85d13cd 100644 --- a/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/CustomRollouts_CreateOrUpdate.json +++ b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/CustomRollouts_CreateOrUpdate.json @@ -23,6 +23,14 @@ "id": "/subscriptions/ab7a8701-f7ef-471a-a2f4-d0ebbf494f77providers/Microsoft.ProviderHub/providerRegistrations/Microsoft.Contoso/customRollouts/brazilUsShoeBoxTesting", "name": "Microsoft.Contoso/brazilUsShoeBoxTesting", "type": "Microsoft.ProviderHub/providerRegistrations/customRollouts", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-02-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-02-01T01:01:01.1075056Z" + }, "properties": { "provisioningState": "Succeeded", "specification": { diff --git a/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/CustomRollouts_Get.json b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/CustomRollouts_Get.json index cf7a428009af..3fe51c5d4ab8 100644 --- a/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/CustomRollouts_Get.json +++ b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/CustomRollouts_Get.json @@ -12,6 +12,14 @@ "id": "/subscriptions/ab7a8701-f7ef-471a-a2f4-d0ebbf494f77providers/Microsoft.ProviderHub/providerRegistrations/Microsoft.Contoso/customRollouts/canaryTesting99", "name": "Microsoft.Contoso/canaryTesting99", "type": "Microsoft.ProviderHub/providerRegistrations/customRollouts", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-02-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-02-01T01:01:01.1075056Z" + }, "properties": { "provisioningState": "Completed", "specification": { diff --git a/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/CustomRollouts_ListByProviderRegistration.json b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/CustomRollouts_ListByProviderRegistration.json index a14ead2b17e3..a1ddcbd2f76d 100644 --- a/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/CustomRollouts_ListByProviderRegistration.json +++ b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/CustomRollouts_ListByProviderRegistration.json @@ -13,6 +13,14 @@ "id": "/subscriptions/ab7a8701-f7ef-471a-a2f4-d0ebbf494f77providers/Microsoft.ProviderHub/providerRegistrations/Microsoft.Contoso/customRollouts/canaryTesting99", "name": "Microsoft.Contoso/canaryTesting99", "type": "Microsoft.ProviderHub/providerRegistrations/customRollouts", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-02-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-02-01T01:01:01.1075056Z" + }, "properties": { "provisioningState": "Succeeded", "specification": { @@ -35,6 +43,14 @@ "id": "/subscriptions/ab7a8701-f7ef-471a-a2f4-d0ebbf494f77providers/Microsoft.ProviderHub/providerRegistrations/Microsoft.Contoso/customRollouts/brazilustesting", "name": "Microsoft.Contoso/brazilustesting", "type": "Microsoft.ProviderHub/providerRegistrations/customRollouts", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-02-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-02-01T01:01:01.1075056Z" + }, "properties": { "provisioningState": "Failed", "specification": { diff --git a/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/DefaultRollouts_CreateOrUpdate.json b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/DefaultRollouts_CreateOrUpdate.json index 7836ee7306f8..52a3ddfb802d 100644 --- a/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/DefaultRollouts_CreateOrUpdate.json +++ b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/DefaultRollouts_CreateOrUpdate.json @@ -33,6 +33,14 @@ "id": "/subscriptions/ab7a8701-f7ef-471a-a2f4-d0ebbf494f77providers/Microsoft.ProviderHub/providerRegistrations/Microsoft.Contoso/defaultRollouts/2020week10", "name": "Microsoft.Contoso/2020week10", "type": "Microsoft.ProviderHub/providerRegistrations/defaultRollouts", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-02-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-02-01T01:01:01.1075056Z" + }, "properties": { "provisioningState": "RolloutInProgress", "specification": { @@ -103,6 +111,14 @@ "id": "/subscriptions/ab7a8701-f7ef-471a-a2f4-d0ebbf494f77providers/Microsoft.ProviderHub/providerRegistrations/Microsoft.Contoso/defaultRollouts/2020week10", "name": "Microsoft.Contoso/2020week10", "type": "Microsoft.ProviderHub/providerRegistrations/defaultRollouts", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-02-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-02-01T01:01:01.1075056Z" + }, "properties": { "provisioningState": "RolloutInProgress", "specification": { diff --git a/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/DefaultRollouts_Get.json b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/DefaultRollouts_Get.json index fbb418ce9778..5d8fa9aeb239 100644 --- a/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/DefaultRollouts_Get.json +++ b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/DefaultRollouts_Get.json @@ -12,6 +12,14 @@ "id": "/subscriptions/ab7a8701-f7ef-471a-a2f4-d0ebbf494f77providers/Microsoft.ProviderHub/providerRegistrations/Microsoft.Contoso/defaultRollouts/2020week10", "name": "Microsoft.Contoso/2020week10", "type": "Microsoft.ProviderHub/providerRegistrations/defaultRollouts", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-02-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-02-01T01:01:01.1075056Z" + }, "properties": { "provisioningState": "Cancelled", "specification": { diff --git a/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/DefaultRollouts_ListByProviderRegistration.json b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/DefaultRollouts_ListByProviderRegistration.json index 2a4c07b49637..7ab210079c9a 100644 --- a/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/DefaultRollouts_ListByProviderRegistration.json +++ b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/DefaultRollouts_ListByProviderRegistration.json @@ -13,6 +13,14 @@ "id": "/subscriptions/ab7a8701-f7ef-471a-a2f4-d0ebbf494f77providers/Microsoft.ProviderHub/providerRegistrations/Microsoft.Contoso/defaultRollouts/2020week01", "name": "Microsoft.Contoso/2020week01", "type": "Microsoft.ProviderHub/providerRegistrations/defaultRollouts", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-02-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-02-01T01:01:01.1075056Z" + }, "properties": { "provisioningState": "Succeeded", "specification": { @@ -79,6 +87,14 @@ "id": "/subscriptions/ab7a8701-f7ef-471a-a2f4-d0ebbf494f77providers/Microsoft.ProviderHub/providerRegistrations/Microsoft.Contoso/defaultRollouts/2020week10", "name": "Microsoft.Contoso/2020week10", "type": "Microsoft.ProviderHub/providerRegistrations/defaultRollouts", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-02-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-02-01T01:01:01.1075056Z" + }, "properties": { "provisioningState": "Cancelled", "specification": { diff --git a/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/NotificationRegistrations_CreateOrUpdate.json b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/NotificationRegistrations_CreateOrUpdate.json index 0eb58680e30d..62897789a7c9 100644 --- a/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/NotificationRegistrations_CreateOrUpdate.json +++ b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/NotificationRegistrations_CreateOrUpdate.json @@ -37,6 +37,14 @@ "id": "/subscriptions/ab7a8701-f7ef-471a-a2f4-d0ebbf494f77providers/Microsoft.ProviderHub/providerRegistrations/Microsoft.Contoso/notificationregistrations/fooNotificationRegistration", "type": "Microsoft.ProviderHub/providerRegistrations/notificationregistrations", "name": "fooNotificationRegistration", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-02-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-02-01T01:01:01.1075056Z" + }, "properties": { "notificationMode": "EventHub", "messageScope": "RegisteredSubscriptions", diff --git a/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/NotificationRegistrations_Get.json b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/NotificationRegistrations_Get.json index e4e201d10e20..7cba399a6ebd 100644 --- a/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/NotificationRegistrations_Get.json +++ b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/NotificationRegistrations_Get.json @@ -12,6 +12,14 @@ "id": "/subscriptions/ab7a8701-f7ef-471a-a2f4-d0ebbf494f77providers/Microsoft.ProviderHub/providerRegistrations/Microsoft.Contoso/notificationregistrations/fooNotificationRegistration", "type": "Microsoft.ProviderHub/providerRegistrations/notificationregistrations", "name": "fooNotificationRegistration", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-02-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-02-01T01:01:01.1075056Z" + }, "properties": { "notificationMode": "EventHub", "messageScope": "RegisteredSubscriptions", diff --git a/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/NotificationRegistrations_ListByProviderRegistration.json b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/NotificationRegistrations_ListByProviderRegistration.json index 191983a40da2..88cb9dcde8a7 100644 --- a/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/NotificationRegistrations_ListByProviderRegistration.json +++ b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/NotificationRegistrations_ListByProviderRegistration.json @@ -11,6 +11,14 @@ "value": [ { "name": "fooNotificationRegistration", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-02-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-02-01T01:01:01.1075056Z" + }, "properties": { "notificationMode": "EventHub", "messageScope": "RegisteredSubscriptions", @@ -37,6 +45,14 @@ }, { "name": "barNotificationRegistration", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-02-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-02-01T01:01:01.1075056Z" + }, "properties": { "notificationMode": "EventHub", "messageScope": "RegisteredSubscriptions", diff --git a/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/ProviderRegistrations_CreateOrUpdate.json b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/ProviderRegistrations_CreateOrUpdate.json index 90e871a7baf4..c421ec33a475 100644 --- a/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/ProviderRegistrations_CreateOrUpdate.json +++ b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/ProviderRegistrations_CreateOrUpdate.json @@ -62,6 +62,14 @@ "providerVersion": "2.0", "providerType": "Internal, Hidden", "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-02-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-02-01T01:01:01.1075056Z" } } }, diff --git a/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/ProviderRegistrations_Get.json b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/ProviderRegistrations_Get.json index f2031bd51aa8..36525992e782 100644 --- a/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/ProviderRegistrations_Get.json +++ b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/ProviderRegistrations_Get.json @@ -46,6 +46,14 @@ } ], "metadata": null + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-02-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-02-01T01:01:01.1075056Z" } } } diff --git a/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/ProviderRegistrations_List.json b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/ProviderRegistrations_List.json index a0ad9677589d..818ff0d5ac7e 100644 --- a/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/ProviderRegistrations_List.json +++ b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/ProviderRegistrations_List.json @@ -46,6 +46,14 @@ } ], "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-02-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-02-01T01:01:01.1075056Z" } } ] diff --git a/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/ResourceTypeRegistrations_CreateOrUpdate.json b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/ResourceTypeRegistrations_CreateOrUpdate.json index fa433b0d8c98..101ae54cdb0f 100644 --- a/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/ResourceTypeRegistrations_CreateOrUpdate.json +++ b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/ResourceTypeRegistrations_CreateOrUpdate.json @@ -20,8 +20,7 @@ ], "requiredFeatures": [ "" - ], - "endpointType": "Production" + ] } ], "resourceConcurrencyControlOptions": { @@ -55,6 +54,11 @@ "incidentRoutingTeam": "", "incidentContactEmail": "helpme@contoso.com", "resourceAccessPolicy": "NotSpecified" + }, + "openApiConfiguration": { + "validation": { + "allowNoncompliantCollectionResponse": true + } } } } @@ -127,9 +131,22 @@ "incidentRoutingTeam": "", "incidentContactEmail": "helpme@contoso.com", "resourceAccessPolicy": "NotSpecified" + }, + "openApiConfiguration": { + "validation": { + "allowNoncompliantCollectionResponse": true + } } }, - "name": "employees" + "name": "employees", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-02-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-02-01T01:01:01.1075056Z" + } } }, "201": { @@ -160,19 +177,6 @@ "requiredFeatures": [ "Microsoft.Contoso/RPaaSSampleApp" ] - }, - { - "apiVersions": [ - "2021-06-01-preview" - ], - "locations": [ - "East US 2 EUAP", - "Central US EUAP" - ], - "requiredFeatures": [ - "Microsoft.Contoso/RPaaSSampleApp" - ], - "endpointType": "Canary" } ], "swaggerSpecifications": [ @@ -211,9 +215,22 @@ "incidentRoutingTeam": "", "incidentContactEmail": "helpme@contoso.com", "resourceAccessPolicy": "NotSpecified" + }, + "openApiConfiguration": { + "validation": { + "allowNoncompliantCollectionResponse": true + } } }, - "name": "employees" + "name": "employees", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-02-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-02-01T01:01:01.1075056Z" + } } } } diff --git a/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/ResourceTypeRegistrations_Get.json b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/ResourceTypeRegistrations_Get.json index 0ab19048a42c..1a772e784399 100644 --- a/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/ResourceTypeRegistrations_Get.json +++ b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/ResourceTypeRegistrations_Get.json @@ -72,9 +72,22 @@ "incidentRoutingTeam": "", "incidentContactEmail": "helpme@contoso.com", "resourceAccessPolicy": "NotSpecified" + }, + "openApiConfiguration": { + "validation": { + "allowNoncompliantCollectionResponse": false + } } }, - "name": "employees" + "name": "employees", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-02-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-02-01T01:01:01.1075056Z" + } } } } diff --git a/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/ResourceTypeRegistrations_ListByProviderRegistration.json b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/ResourceTypeRegistrations_ListByProviderRegistration.json index 2f8d7e2e51c4..7af5619015eb 100644 --- a/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/ResourceTypeRegistrations_ListByProviderRegistration.json +++ b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/ResourceTypeRegistrations_ListByProviderRegistration.json @@ -73,9 +73,22 @@ "incidentRoutingTeam": "", "incidentContactEmail": "helpme@contoso.com", "resourceAccessPolicy": "NotSpecified" + }, + "openApiConfiguration": { + "validation": { + "allowNoncompliantCollectionResponse": false + } } }, - "name": "employees" + "name": "employees", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-02-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-02-01T01:01:01.1075056Z" + } } ] } diff --git a/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/Skus_CreateOrUpdate.json b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/Skus_CreateOrUpdate.json index 3d9dda128fba..9962b47bacb4 100644 --- a/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/Skus_CreateOrUpdate.json +++ b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/Skus_CreateOrUpdate.json @@ -31,7 +31,15 @@ "body": { "id": "/subscriptions/ab7a8701-f7ef-471a-a2f4-d0ebbf494f77providers/Microsoft.ProviderHub/providerRegistrations/Microsoft.Contoso/", "name": "Microsoft.Contoso/", - "type": "Microsoft.ProviderHub/providerRegistrations/" + "type": "Microsoft.ProviderHub/providerRegistrations/", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-02-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-02-01T01:01:01.1075056Z" + } } } } diff --git a/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/Skus_CreateOrUpdateNestedResourceTypeFirst.json b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/Skus_CreateOrUpdateNestedResourceTypeFirst.json index 80d5a76eb35c..144031b9da8f 100644 --- a/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/Skus_CreateOrUpdateNestedResourceTypeFirst.json +++ b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/Skus_CreateOrUpdateNestedResourceTypeFirst.json @@ -32,7 +32,15 @@ "body": { "id": "/subscriptions/ab7a8701-f7ef-471a-a2f4-d0ebbf494f77providers/Microsoft.ProviderHub/providerRegistrations/Microsoft.Contoso/", "name": "Microsoft.Contoso/", - "type": "Microsoft.ProviderHub/providerRegistrations/" + "type": "Microsoft.ProviderHub/providerRegistrations/", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-02-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-02-01T01:01:01.1075056Z" + } } } } diff --git a/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/Skus_CreateOrUpdateNestedResourceTypeSecond.json b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/Skus_CreateOrUpdateNestedResourceTypeSecond.json index 978d209db248..c9bbd2a2e45a 100644 --- a/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/Skus_CreateOrUpdateNestedResourceTypeSecond.json +++ b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/Skus_CreateOrUpdateNestedResourceTypeSecond.json @@ -33,7 +33,15 @@ "body": { "id": "/subscriptions/ab7a8701-f7ef-471a-a2f4-d0ebbf494f77providers/Microsoft.ProviderHub/providerRegistrations/Microsoft.Contoso/", "name": "Microsoft.Contoso/", - "type": "Microsoft.ProviderHub/providerRegistrations/" + "type": "Microsoft.ProviderHub/providerRegistrations/", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-02-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-02-01T01:01:01.1075056Z" + } } } } diff --git a/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/Skus_CreateOrUpdateNestedResourceTypeThird.json b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/Skus_CreateOrUpdateNestedResourceTypeThird.json index 9d7c44624f0a..fbb79b66259b 100644 --- a/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/Skus_CreateOrUpdateNestedResourceTypeThird.json +++ b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/Skus_CreateOrUpdateNestedResourceTypeThird.json @@ -34,7 +34,15 @@ "body": { "id": "/subscriptions/ab7a8701-f7ef-471a-a2f4-d0ebbf494f77providers/Microsoft.ProviderHub/providerRegistrations/Microsoft.Contoso/", "name": "Microsoft.Contoso/", - "type": "Microsoft.ProviderHub/providerRegistrations/" + "type": "Microsoft.ProviderHub/providerRegistrations/", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-02-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-02-01T01:01:01.1075056Z" + } } } } diff --git a/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/Skus_Get.json b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/Skus_Get.json index 4020c4e0b0cb..31d706af9a58 100644 --- a/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/Skus_Get.json +++ b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/Skus_Get.json @@ -28,6 +28,14 @@ ] } ] + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-02-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-02-01T01:01:01.1075056Z" } } } diff --git a/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/Skus_GetNestedResourceTypeFirst.json b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/Skus_GetNestedResourceTypeFirst.json index 58eedd1bddac..65dcf73ffd4b 100644 --- a/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/Skus_GetNestedResourceTypeFirst.json +++ b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/Skus_GetNestedResourceTypeFirst.json @@ -29,6 +29,14 @@ ] } ] + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-02-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-02-01T01:01:01.1075056Z" } } } diff --git a/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/Skus_GetNestedResourceTypeSecond.json b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/Skus_GetNestedResourceTypeSecond.json index 17d31b41514e..24a6b44aaf56 100644 --- a/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/Skus_GetNestedResourceTypeSecond.json +++ b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/Skus_GetNestedResourceTypeSecond.json @@ -30,6 +30,14 @@ ] } ] + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-02-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-02-01T01:01:01.1075056Z" } } } diff --git a/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/Skus_GetNestedResourceTypeThird.json b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/Skus_GetNestedResourceTypeThird.json index 6f2078d52d38..71bd93be92db 100644 --- a/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/Skus_GetNestedResourceTypeThird.json +++ b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/Skus_GetNestedResourceTypeThird.json @@ -31,6 +31,14 @@ ] } ] + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-02-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-02-01T01:01:01.1075056Z" } } } diff --git a/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/Skus_ListByResourceTypeRegistrations.json b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/Skus_ListByResourceTypeRegistrations.json index a1685f6484cc..49c4c5e57242 100644 --- a/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/Skus_ListByResourceTypeRegistrations.json +++ b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/Skus_ListByResourceTypeRegistrations.json @@ -29,6 +29,14 @@ ] } ] + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-02-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-02-01T01:01:01.1075056Z" } } ] diff --git a/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/Skus_ListByResourceTypeRegistrationsNestedResourceTypeFirst.json b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/Skus_ListByResourceTypeRegistrationsNestedResourceTypeFirst.json index d4a69bb4e362..7c3c4815df58 100644 --- a/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/Skus_ListByResourceTypeRegistrationsNestedResourceTypeFirst.json +++ b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/Skus_ListByResourceTypeRegistrationsNestedResourceTypeFirst.json @@ -30,6 +30,14 @@ ] } ] + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-02-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-02-01T01:01:01.1075056Z" } } ] diff --git a/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/Skus_ListByResourceTypeRegistrationsNestedResourceTypeSecond.json b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/Skus_ListByResourceTypeRegistrationsNestedResourceTypeSecond.json index 759da8e45a9f..a312436580fa 100644 --- a/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/Skus_ListByResourceTypeRegistrationsNestedResourceTypeSecond.json +++ b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/Skus_ListByResourceTypeRegistrationsNestedResourceTypeSecond.json @@ -32,6 +32,14 @@ ] } ] + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-02-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-02-01T01:01:01.1075056Z" } } ] diff --git a/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/Skus_ListByResourceTypeRegistrationsNestedResourceTypeThird.json b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/Skus_ListByResourceTypeRegistrationsNestedResourceTypeThird.json index 2cd2dfc5db7c..a641d3ecffc8 100644 --- a/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/Skus_ListByResourceTypeRegistrationsNestedResourceTypeThird.json +++ b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/Skus_ListByResourceTypeRegistrationsNestedResourceTypeThird.json @@ -33,6 +33,14 @@ ] } ] + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-02-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-02-01T01:01:01.1075056Z" } } ] diff --git a/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/providerhub.json b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/providerhub.json index 00535a63c1ae..4695d71164b8 100644 --- a/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/providerhub.json +++ b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/providerhub.json @@ -2377,6 +2377,10 @@ } ], "description": "Properties of the rollout." + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/systemData", + "readOnly": true } }, "x-ms-azure-resource": true @@ -2641,6 +2645,10 @@ } ], "description": "Properties of the rollout." + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/systemData", + "readOnly": true } }, "x-ms-azure-resource": true @@ -3557,6 +3565,10 @@ "$ref": "#/definitions/NotificationRegistrationProperties" } ] + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/systemData", + "readOnly": true } }, "x-ms-azure-resource": true @@ -4159,6 +4171,10 @@ "$ref": "#/definitions/ProviderRegistrationProperties" } ] + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/systemData", + "readOnly": true } }, "x-ms-azure-resource": true @@ -4607,6 +4623,9 @@ "$ref": "#/definitions/ResourceProviderManagement" } ] + }, + "openApiConfiguration": { + "$ref": "#/definitions/OpenApiConfiguration" } } }, @@ -4624,6 +4643,10 @@ "$ref": "#/definitions/ResourceTypeRegistrationProperties" } ] + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/systemData", + "readOnly": true } }, "x-ms-azure-resource": true @@ -4860,6 +4883,10 @@ "$ref": "#/definitions/ResourceTypeSku" } ] + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/systemData", + "readOnly": true } }, "x-ms-azure-resource": true @@ -4879,6 +4906,23 @@ } } }, + "OpenApiConfiguration": { + "type": "object", + "properties": { + "validation": { + "$ref": "#/definitions/OpenApiValidation" + } + } + }, + "OpenApiValidation": { + "type": "object", + "properties": { + "allowNoncompliantCollectionResponse": { + "description": "Indicates whether a non compliance response is allowed for a LIST call", + "type": "boolean" + } + } + }, "ResourceManagementEntity": { "required": [ "resourceId" diff --git a/specification/providerhub/resource-manager/Microsoft.ProviderHub/stable/2020-11-20/providerhub.json b/specification/providerhub/resource-manager/Microsoft.ProviderHub/stable/2020-11-20/providerhub.json index c0d4179fb1b1..c3c23e46a2ca 100644 --- a/specification/providerhub/resource-manager/Microsoft.ProviderHub/stable/2020-11-20/providerhub.json +++ b/specification/providerhub/resource-manager/Microsoft.ProviderHub/stable/2020-11-20/providerhub.json @@ -3461,6 +3461,28 @@ "items": { "$ref": "#/definitions/NotificationEndpoint" } + }, + "provisioningState": { + "enum": [ + "NotSpecified", + "Accepted", + "Running", + "Creating", + "Created", + "Deleting", + "Deleted", + "Canceled", + "Failed", + "Succeeded", + "MovingResources", + "TransientFailure", + "RolloutInProgress" + ], + "type": "string", + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } } } }, @@ -4526,6 +4548,28 @@ "items": { "$ref": "#/definitions/SkuSetting" } + }, + "provisioningState": { + "enum": [ + "NotSpecified", + "Accepted", + "Running", + "Creating", + "Created", + "Deleting", + "Deleted", + "Canceled", + "Failed", + "Succeeded", + "MovingResources", + "TransientFailure", + "RolloutInProgress" + ], + "type": "string", + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } } } }, diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Account/preview/2019-11-01-preview/account.json b/specification/purview/data-plane/Azure.Analytics.Purview.Account/preview/2019-11-01-preview/account.json index f56908bfcb27..a07c2d4c6508 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.Account/preview/2019-11-01-preview/account.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Account/preview/2019-11-01-preview/account.json @@ -161,254 +161,6 @@ } } }, - "/businessRules/{businessRuleName}": { - "get": { - "tags": [ - "BusinessRule" - ], - "description": "Get a business rule model.", - "operationId": "BusinessRules_Get", - "parameters": [ - { - "name": "businessRuleName", - "in": "path", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/BusinessRule" - } - }, - "default": { - "description": "An error response received from the provider.", - "schema": { - "$ref": "#/definitions/ErrorResponseModel" - } - } - }, - "x-ms-examples": { - "BusinessRules_Get": { - "$ref": "./examples/BusinessRules_Get.json" - } - } - }, - "put": { - "tags": [ - "BusinessRule" - ], - "description": "Creates or updates a businessRule.", - "operationId": "BusinessRules_CreateOrUpdate", - "parameters": [ - { - "name": "businessRuleName", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "businessRule", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/BusinessRule" - } - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/BusinessRule" - } - }, - "default": { - "description": "An error response received from the provider.", - "schema": { - "$ref": "#/definitions/ErrorResponseModel" - } - } - }, - "x-ms-examples": { - "BusinessRules_CreateOrUpdate": { - "$ref": "./examples/BusinessRules_CreateOrUpdate.json" - } - } - }, - "delete": { - "tags": [ - "BusinessRule" - ], - "description": "Deletes a BusinessRule resource.", - "operationId": "BusinessRules_Delete", - "parameters": [ - { - "name": "businessRuleName", - "in": "path", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "Success" - }, - "204": { - "description": "Success" - }, - "default": { - "description": "An error response received from the provider.", - "schema": { - "$ref": "#/definitions/ErrorResponseModel" - } - } - }, - "x-ms-examples": { - "BusinessRules_Delete": { - "$ref": "./examples/BusinessRules_Delete.json" - } - } - } - }, - "/businessRules": { - "get": { - "tags": [ - "BusinessRule" - ], - "description": "List the businessRules in the account.", - "operationId": "BusinessRules_ListByAccount", - "parameters": [ - { - "$ref": "#/parameters/api-version" - }, - { - "name": "metadataOnly", - "in": "query", - "required": false, - "type": "boolean", - "default": false - }, - { - "name": "$skipToken", - "in": "query", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/BusinessRuleList" - } - }, - "default": { - "description": "An error response received from the provider.", - "schema": { - "$ref": "#/definitions/ErrorResponseModel" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "BusinessRules_ListByAccount": { - "$ref": "./examples/BusinessRules_ListByAccount.json" - } - } - } - }, - "/businessRules/{businessRuleName}/enable": { - "post": { - "tags": [ - "BusinessRule" - ], - "description": "Enables a BusinessRule.", - "operationId": "BusinessRules_Enable", - "parameters": [ - { - "name": "businessRuleName", - "in": "path", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/BusinessRule" - } - }, - "default": { - "description": "An error response received from the provider.", - "schema": { - "$ref": "#/definitions/ErrorResponseModel" - } - } - }, - "x-ms-examples": { - "BusinessRules_Enable": { - "$ref": "./examples/BusinessRules_Enable.json" - } - } - } - }, - "/businessRules/{businessRuleName}/disable": { - "post": { - "tags": [ - "BusinessRule" - ], - "description": "Disables a BusinessRule.", - "operationId": "BusinessRules_Disable", - "parameters": [ - { - "name": "businessRuleName", - "in": "path", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/BusinessRule" - } - }, - "default": { - "description": "An error response received from the provider.", - "schema": { - "$ref": "#/definitions/ErrorResponseModel" - } - } - }, - "x-ms-examples": { - "BusinessRules_Disable": { - "$ref": "./examples/BusinessRules_Disable.json" - } - } - } - }, "/collections/{collectionName}": { "get": { "tags": [ @@ -1291,127 +1043,6 @@ } } }, - "BusinessRule": { - "description": "Filter resource", - "type": "object", - "properties": { - "businessRuleMetadata": { - "$ref": "#/definitions/BusinessRuleMetadata", - "description": "Gets or sets the properties." - }, - "name": { - "description": "Gets or sets the name.", - "type": "string" - }, - "ruleJson": { - "description": "Gets or sets the actual rule json as a string.", - "type": "string" - } - } - }, - "BusinessRuleMetadata": { - "description": "The business rule properties", - "type": "object", - "properties": { - "catalogId": { - "description": "Gets or sets the catalog id associated with the business rule.", - "type": "string", - "readOnly": true - }, - "createdBy": { - "description": "Gets or sets the creator of the business rule.", - "type": "string", - "readOnly": true - }, - "createTimestamp": { - "format": "date-time", - "description": "Gets or sets the create timestamp of the business rule.", - "type": "string", - "readOnly": true - }, - "description": { - "description": "Gets or sets the description of the business rule.", - "type": "string" - }, - "expirationTimestamp": { - "format": "date-time", - "description": "Gets or sets the expiration time stamp of the business rule.", - "type": "string" - }, - "friendlyName": { - "description": "Gets or sets the friendly name of the business rule.", - "type": "string" - }, - "lastModifiedTimestamp": { - "format": "date-time", - "description": "Gets or sets the last modified timestamp of the business rule.", - "type": "string", - "readOnly": true - }, - "modifiedBy": { - "description": "Gets or sets the modifier of the business rule.", - "type": "string", - "readOnly": true - }, - "name": { - "description": "Gets or sets the name of the business rule.", - "type": "string", - "readOnly": true - }, - "rank": { - "format": "int32", - "description": "Gets or sets the rank of the business rule.", - "type": "integer" - }, - "ruleStatus": { - "description": "Gets or sets the status of the business rule.", - "enum": [ - "Unknown", - "Draft", - "Enabled", - "Disabled", - "Expired" - ], - "type": "string", - "x-ms-enum": { - "name": "ruleStatus", - "modelAsString": true - } - }, - "version": { - "format": "int32", - "description": "Gets or sets the version of the business rule.", - "type": "integer", - "readOnly": true - } - } - }, - "BusinessRuleList": { - "description": "Paged list of business rules", - "required": [ - "value" - ], - "type": "object", - "properties": { - "count": { - "format": "int64", - "description": "Total item count.", - "type": "integer" - }, - "nextLink": { - "description": "The Url of next result page.", - "type": "string" - }, - "value": { - "description": "Collection of items of type results.", - "uniqueItems": false, - "type": "array", - "items": { - "$ref": "#/definitions/BusinessRule" - } - } - } - }, "Collection": { "description": "Collection resource.", "type": "object", diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Account/preview/2019-11-01-preview/examples/BusinessRules_CreateOrUpdate.json b/specification/purview/data-plane/Azure.Analytics.Purview.Account/preview/2019-11-01-preview/examples/BusinessRules_CreateOrUpdate.json deleted file mode 100644 index 197761fb9d53..000000000000 --- a/specification/purview/data-plane/Azure.Analytics.Purview.Account/preview/2019-11-01-preview/examples/BusinessRules_CreateOrUpdate.json +++ /dev/null @@ -1,43 +0,0 @@ -{ - "parameters": { - "businessRuleName": "myBusinessRule", - "api-version": "2019-11-01-preview", - "businessRule": { - "name": "myBusinessRule", - "ruleJson": "rule1", - "businessRuleMetadata": { - "friendlyName": "myBusinessRuleFriendlyName", - "ruleStatus": "Enabled", - "description": "A sample business rule", - "rank": 1 - } - } - }, - "responses": { - "200": { - "headers": { - "Date": "Wed, 13 Sep 2017 18:04:32 GMT", - "x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888", - "X-Content-Type-Options": "nosniff", - "x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd" - }, - "body": { - "name": "myBusinessRule", - "ruleJson": "rule1", - "businessRuleMetadata": { - "catalogId": "d5496da4-9c52-402f-b067-83cc9ddea885", - "friendlyName": "myBusinessRuleFriendlyName", - "ruleStatus": "Enabled", - "expirationTimestamp": "2022-11-22T18:39:58.6929344Z", - "createTimestamp": "2019-11-22T18:39:58.6929344Z", - "lastModifiedTimestamp": "2019-11-22T18:39:58.6929344Z", - "description": "A sample business rule", - "rank": 1, - "version": 1, - "createdBy": "client-name", - "modifiedBy": "modifier-name" - } - } - } - } -} diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Account/preview/2019-11-01-preview/examples/BusinessRules_Delete.json b/specification/purview/data-plane/Azure.Analytics.Purview.Account/preview/2019-11-01-preview/examples/BusinessRules_Delete.json deleted file mode 100644 index ba15d5d98ccd..000000000000 --- a/specification/purview/data-plane/Azure.Analytics.Purview.Account/preview/2019-11-01-preview/examples/BusinessRules_Delete.json +++ /dev/null @@ -1,24 +0,0 @@ -{ - "parameters": { - "businessRuleName": "myBusinessRule", - "api-version": "2019-11-01-preview" - }, - "responses": { - "200": { - "headers": { - "Date": "Wed, 13 Sep 2017 18:04:32 GMT", - "x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888", - "X-Content-Type-Options": "nosniff", - "x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd" - } - }, - "204": { - "headers": { - "Date": "Wed, 13 Sep 2017 18:04:32 GMT", - "x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888", - "X-Content-Type-Options": "nosniff", - "x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd" - } - } - } -} diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Account/preview/2019-11-01-preview/examples/BusinessRules_Disable.json b/specification/purview/data-plane/Azure.Analytics.Purview.Account/preview/2019-11-01-preview/examples/BusinessRules_Disable.json deleted file mode 100644 index 76e2d3d273d0..000000000000 --- a/specification/purview/data-plane/Azure.Analytics.Purview.Account/preview/2019-11-01-preview/examples/BusinessRules_Disable.json +++ /dev/null @@ -1,33 +0,0 @@ -{ - "parameters": { - "businessRuleName": "myBusinessRule", - "api-version": "2019-11-01-preview" - }, - "responses": { - "200": { - "headers": { - "Date": "Wed, 13 Sep 2017 18:04:32 GMT", - "x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888", - "X-Content-Type-Options": "nosniff", - "x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd" - }, - "body": { - "name": "myBusinessRule", - "ruleJson": "rule1", - "businessRuleMetadata": { - "catalogId": "d5496da4-9c52-402f-b067-83cc9ddea885", - "friendlyName": "myBusinessRuleFriendlyName", - "ruleStatus": "Disabled", - "expirationTimestamp": "2022-11-22T18:39:58.6929344Z", - "createTimestamp": "2019-11-22T18:39:58.6929344Z", - "lastModifiedTimestamp": "2019-11-22T18:39:58.6929344Z", - "description": "A sample business rule", - "rank": 1, - "version": 1, - "createdBy": "client-name", - "modifiedBy": "modifier-name" - } - } - } - } -} diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Account/preview/2019-11-01-preview/examples/BusinessRules_Enable.json b/specification/purview/data-plane/Azure.Analytics.Purview.Account/preview/2019-11-01-preview/examples/BusinessRules_Enable.json deleted file mode 100644 index f2bef7c4abd8..000000000000 --- a/specification/purview/data-plane/Azure.Analytics.Purview.Account/preview/2019-11-01-preview/examples/BusinessRules_Enable.json +++ /dev/null @@ -1,33 +0,0 @@ -{ - "parameters": { - "businessRuleName": "myBusinessRule", - "api-version": "2019-11-01-preview" - }, - "responses": { - "200": { - "headers": { - "Date": "Wed, 13 Sep 2017 18:04:32 GMT", - "x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888", - "X-Content-Type-Options": "nosniff", - "x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd" - }, - "body": { - "name": "myBusinessRule", - "ruleJson": "rule1", - "businessRuleMetadata": { - "catalogId": "d5496da4-9c52-402f-b067-83cc9ddea885", - "friendlyName": "myBusinessRuleFriendlyName", - "ruleStatus": "Enabled", - "expirationTimestamp": "2022-11-22T18:39:58.6929344Z", - "createTimestamp": "2019-11-22T18:39:58.6929344Z", - "lastModifiedTimestamp": "2019-11-22T18:39:58.6929344Z", - "description": "A sample business rule", - "rank": 1, - "version": 1, - "createdBy": "client-name", - "modifiedBy": "modifier-name" - } - } - } - } -} diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Account/preview/2019-11-01-preview/examples/BusinessRules_Get.json b/specification/purview/data-plane/Azure.Analytics.Purview.Account/preview/2019-11-01-preview/examples/BusinessRules_Get.json deleted file mode 100644 index f2bef7c4abd8..000000000000 --- a/specification/purview/data-plane/Azure.Analytics.Purview.Account/preview/2019-11-01-preview/examples/BusinessRules_Get.json +++ /dev/null @@ -1,33 +0,0 @@ -{ - "parameters": { - "businessRuleName": "myBusinessRule", - "api-version": "2019-11-01-preview" - }, - "responses": { - "200": { - "headers": { - "Date": "Wed, 13 Sep 2017 18:04:32 GMT", - "x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888", - "X-Content-Type-Options": "nosniff", - "x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd" - }, - "body": { - "name": "myBusinessRule", - "ruleJson": "rule1", - "businessRuleMetadata": { - "catalogId": "d5496da4-9c52-402f-b067-83cc9ddea885", - "friendlyName": "myBusinessRuleFriendlyName", - "ruleStatus": "Enabled", - "expirationTimestamp": "2022-11-22T18:39:58.6929344Z", - "createTimestamp": "2019-11-22T18:39:58.6929344Z", - "lastModifiedTimestamp": "2019-11-22T18:39:58.6929344Z", - "description": "A sample business rule", - "rank": 1, - "version": 1, - "createdBy": "client-name", - "modifiedBy": "modifier-name" - } - } - } - } -} diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Account/preview/2019-11-01-preview/examples/BusinessRules_ListByAccount.json b/specification/purview/data-plane/Azure.Analytics.Purview.Account/preview/2019-11-01-preview/examples/BusinessRules_ListByAccount.json deleted file mode 100644 index 4b905c7454bd..000000000000 --- a/specification/purview/data-plane/Azure.Analytics.Purview.Account/preview/2019-11-01-preview/examples/BusinessRules_ListByAccount.json +++ /dev/null @@ -1,36 +0,0 @@ -{ - "parameters": { - "api-version": "2019-11-01-preview" - }, - "responses": { - "200": { - "headers": { - "Date": "Wed, 13 Sep 2017 18:04:32 GMT", - "x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888", - "X-Content-Type-Options": "nosniff", - "x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd" - }, - "body": { - "value": [ - { - "name": "myBusinessRule", - "ruleJson": "rule1", - "businessRuleMetadata": { - "catalogId": "d5496da4-9c52-402f-b067-83cc9ddea885", - "friendlyName": "myBusinessRuleFriendlyName", - "ruleStatus": "Enabled", - "expirationTimestamp": "2022-11-22T18:39:58.6929344Z", - "createTimestamp": "2019-11-22T18:39:58.6929344Z", - "lastModifiedTimestamp": "2019-11-22T18:39:58.6929344Z", - "description": "A sample business rule", - "rank": 1, - "version": 1, - "createdBy": "client-name", - "modifiedBy": "modifier-name" - } - } - ] - } - } - } -} diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Account/preview/2019-11-01-preview/examples/ResourceSetRuleConfigs_CreateOrUpdate.json b/specification/purview/data-plane/Azure.Analytics.Purview.Account/preview/2019-11-01-preview/examples/ResourceSetRuleConfigs_CreateOrUpdate.json index fd1bfd01d8c1..f7d6a39c5314 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.Account/preview/2019-11-01-preview/examples/ResourceSetRuleConfigs_CreateOrUpdate.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Account/preview/2019-11-01-preview/examples/ResourceSetRuleConfigs_CreateOrUpdate.json @@ -210,6 +210,9 @@ "lastUpdatedTimestamp": 0 } ] + }, + "advancedResourceSet": { + "resourceSetProcessing": "Default" } } }, @@ -441,6 +444,10 @@ "typeName": "Microsoft.DataMap.PathPattern.SparkPathReplacer" } ] + }, + "advancedResourceSet": { + "resourceSetProcessing": "Default", + "modifiedAt": "2021-07-08T23:14:06.4084575Z" } } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Account/preview/2019-11-01-preview/examples/ResourceSetRuleConfigs_Get.json b/specification/purview/data-plane/Azure.Analytics.Purview.Account/preview/2019-11-01-preview/examples/ResourceSetRuleConfigs_Get.json index a8d8101a09c4..9883a87162df 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.Account/preview/2019-11-01-preview/examples/ResourceSetRuleConfigs_Get.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Account/preview/2019-11-01-preview/examples/ResourceSetRuleConfigs_Get.json @@ -232,6 +232,10 @@ "typeName": "Microsoft.DataMap.PathPattern.SparkPathReplacer" } ] + }, + "advancedResourceSet": { + "resourceSetProcessing": "Advanced", + "modifiedAt": "2021-07-08T23:14:06.4084575Z" } } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Account/preview/2019-11-01-preview/examples/ResourceSetRuleConfigs_ListByAccount.json b/specification/purview/data-plane/Azure.Analytics.Purview.Account/preview/2019-11-01-preview/examples/ResourceSetRuleConfigs_ListByAccount.json index 8b7f3e7cc5b4..e85a31748936 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.Account/preview/2019-11-01-preview/examples/ResourceSetRuleConfigs_ListByAccount.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Account/preview/2019-11-01-preview/examples/ResourceSetRuleConfigs_ListByAccount.json @@ -234,6 +234,10 @@ "typeName": "Microsoft.DataMap.PathPattern.SparkPathReplacer" } ] + }, + "advancedResourceSet": { + "resourceSetProcessing": "Default", + "modifiedAt": "2021-07-08T23:14:06.4084575Z" } } ] diff --git a/specification/redis/resource-manager/readme.go.md b/specification/redis/resource-manager/readme.go.md index ee0d0131da53..925e0395be6f 100644 --- a/specification/redis/resource-manager/readme.go.md +++ b/specification/redis/resource-manager/readme.go.md @@ -2,13 +2,21 @@ These settings apply only when `--go` is specified on the command line. -``` yaml $(go) +``` yaml $(go) && !$(track2) go: license-header: MICROSOFT_MIT_NO_VERSION namespace: redis clear-output-folder: true ``` +``` yaml $(go) && $(track2) +license-header: MICROSOFT_MIT_NO_VERSION +module-name: sdk/redis/armredis +module: github.com/Azure/azure-sdk-for-go/$(module-name) +output-folder: $(go-sdk-folder)/$(module-name) +azure-arm: true +``` + ### Go multi-api ``` yaml $(go) && $(multiapi) diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/devices.json b/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/devices.json deleted file mode 100644 index 6a3e58596326..000000000000 --- a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/devices.json +++ /dev/null @@ -1,640 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "Security Center", - "description": "API spec for Microsoft.Security (Azure Security Center) resource provider", - "version": "2020-08-06-preview" - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ], - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Azure Active Directory OAuth2 Flow", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "paths": { - "/subscriptions/{subscriptionId}/providers/Microsoft.Security/devices": { - "get": { - "x-ms-examples": { - "Get Devices": { - "$ref": "./examples/Devices/GetDevicesListForSubscription.json" - } - }, - "tags": [ - "Device Inventory" - ], - "description": "Get list of the devices by their subscription.", - "operationId": "DevicesForSubscription_List", - "parameters": [ - { - "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" - }, - { - "in": "query", - "name": "$limit", - "required": false, - "type": "integer", - "format": "int32", - "description": "Limit the number of items returned in a single page" - }, - { - "in": "query", - "name": "$skipToken", - "required": false, - "type": "string", - "description": "Skip token used for pagination" - }, - { - "in": "query", - "name": "deviceManagementType", - "required": false, - "type": "string", - "enum": [ - "Managed", - "Unmanaged" - ], - "description": "Get devices only from specific type, Managed or Unmanaged.", - "x-ms-enum": { - "name": "ManagementState", - "modelAsString": true - } - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/DeviceList" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/definitions/CloudError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/{resourceId}/providers/Microsoft.Security/devices": { - "get": { - "x-ms-examples": { - "Get Devices": { - "$ref": "./examples/Devices/GetDevicesListForHub.json" - } - }, - "tags": [ - "Device Inventory" - ], - "description": "Get list of the devices for the specified IoT Hub resource.", - "operationId": "DevicesForHub_List", - "parameters": [ - { - "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/ResourceId" - }, - { - "in": "query", - "name": "$limit", - "required": false, - "type": "integer", - "format": "int32", - "description": "Limit the number of items returned in a single page" - }, - { - "in": "query", - "name": "$skipToken", - "required": false, - "type": "string", - "description": "Skip token used for pagination" - }, - { - "in": "query", - "name": "deviceManagementType", - "required": false, - "type": "string", - "enum": [ - "Managed", - "Unmanaged" - ], - "description": "Get devices only from specific type, Managed or Unmanaged.", - "x-ms-enum": { - "name": "ManagementState", - "modelAsString": true - } - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/DeviceList" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/definitions/CloudError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/{resourceId}/providers/Microsoft.Security/devices/{deviceId}": { - "get": { - "x-ms-examples": { - "Get Device": { - "$ref": "./examples/Devices/GetDevice.json" - } - }, - "tags": [ - "Device Inventory" - ], - "description": "Get device.", - "operationId": "Device_Get", - "parameters": [ - { - "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/ResourceId" - }, - { - "$ref": "#/parameters/DeviceId" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Device" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/definitions/CloudError" - } - } - } - } - } - }, - "definitions": { - "DeviceList": { - "description": "List of Devices", - "required": [ - "value" - ], - "properties": { - "value": { - "type": "array", - "description": "List of devices", - "items": { - "$ref": "#/definitions/Device" - } - }, - "nextLink": { - "readOnly": true, - "type": "string", - "description": "When there are too many devices for one page, use this URI to fetch the next page." - } - } - }, - "Device": { - "type": "object", - "description": "Device model", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "description": "Device data", - "$ref": "#/definitions/DeviceProperties" - } - }, - "allOf": [ - { - "$ref": "../../../common/v1/types.json#/definitions/Resource" - } - ] - }, - "DeviceProperties": { - "type": "object", - "description": "Device Information", - "properties": { - "displayName": { - "type": "string", - "description": "Device display name given by the collector" - }, - "deviceType": { - "type": "string", - "description": "Device type." - }, - "sourceName": { - "readOnly": true, - "type": "string", - "description": "The source that created the device" - }, - "networkInterfaces": { - "readOnly": true, - "type": "array", - "description": "List of network interfaces.", - "items": { - "$ref": "#/definitions/NetworkInterface" - } - }, - "vendor": { - "readOnly": true, - "type": "string", - "description": "Device vendor" - }, - "osName": { - "description": "Device operating system name.", - "type": "string" - }, - "protocols": { - "readOnly": true, - "type": "array", - "description": "List of protocols.", - "items": { - "$ref": "#/definitions/Protocol" - } - }, - "lastActiveTime": { - "readOnly": true, - "type": "string", - "format": "date-time", - "description": "last time the device was active in the network" - }, - "lastUpdateTime": { - "readOnly": true, - "type": "string", - "format": "date-time", - "description": "last time the device was updated" - }, - "managementState": { - "readOnly": true, - "type": "string", - "enum": [ - "Managed", - "Unmanaged" - ], - "description": "Managed state of the device.", - "x-ms-enum": { - "name": "ManagementState", - "modelAsString": true - } - }, - "authorizationState": { - "type": "string", - "enum": [ - "Authorized", - "Unauthorized" - ], - "default": "Unauthorized", - "description": "Authorized state of the device.", - "x-ms-enum": { - "name": "AuthorizationState", - "modelAsString": true - } - }, - "deviceCriticality": { - "type": "string", - "enum": [ - "Important", - "Standard" - ], - "default": "Standard", - "x-ms-enum": { - "name": "DeviceCriticality", - "modelAsString": true - }, - "description": "Device criticality." - }, - "purdueLevel": { - "type": "string", - "enum": [ - "ProcessControl", - "Supervisory", - "Enterprise" - ], - "default": "ProcessControl", - "x-ms-enum": { - "name": "PurdueLevel", - "modelAsString": true - }, - "description": "Purdue level of the device." - }, - "notes": { - "type": "string", - "description": "user notes for the device, up to 300 characters." - }, - "firmwares": { - "readOnly": true, - "type": "array", - "description": "List of device firmwares.", - "items": { - "$ref": "#/definitions/Firmware" - } - }, - "discoveryTime": { - "readOnly": true, - "type": "string", - "format": "date-time", - "description": "Discovered time of the device." - }, - "programmingState": { - "readOnly": true, - "type": "string", - "enum": [ - "ProgrammingDevice", - "NotProgrammingDevice" - ], - "x-ms-enum": { - "name": "ProgrammingState", - "modelAsString": true - }, - "description": "Indicates whether this device is programming" - }, - "lastProgrammingTime": { - "readOnly": true, - "type": "string", - "format": "date-time", - "description": "last time the device was programming or programed." - }, - "scanningFunctionality": { - "readOnly": true, - "type": "string", - "enum": [ - "ScannerDevice", - "NotScannerDevice" - ], - "x-ms-enum": { - "name": "ScanningFunctionality", - "modelAsString": true - }, - "description": "Indicates whether the device is a scanner" - }, - "lastScanTime": { - "readOnly": true, - "type": "string", - "format": "date-time", - "description": "last time the device was scanning." - }, - "riskScore": { - "readOnly": true, - "type": "integer", - "format": "int32", - "minimum": 0, - "maximum": 100, - "description": "risk score of the device." - }, - "sensors": { - "readOnly": true, - "type": "array", - "description": "List of sensors that scanned this device.", - "items": { - "$ref": "#/definitions/Sensor" - } - }, - "site": { - "readOnly": true, - "$ref": "#/definitions/Site" - }, - "deviceStatus": { - "readOnly": true, - "type": "string", - "enum": [ - "Active", - "Removed" - ], - "x-ms-enum": { - "name": "DeviceStatus", - "modelAsString": true - }, - "description": "Device status." - } - } - }, - "NetworkInterface": { - "type": "object", - "description": "Network interface", - "properties": { - "ipAddress": { - "$ref": "#/definitions/IpAddress" - }, - "macAddress": { - "$ref": "#/definitions/MacAddress" - }, - "vlans": { - "readOnly": true, - "type": "array", - "description": "List of device vlans.", - "items": { - "type": "string" - } - } - } - }, - "IpAddress": { - "type": "object", - "description": "IP Address information", - "properties": { - "v4Address": { - "readOnly": true, - "type": "string", - "description": "IPV4 address" - }, - "detectionTime": { - "readOnly": true, - "type": "string", - "format": "date-time", - "description": "Detection time of the ip address." - }, - "subnetCidr": { - "readOnly": true, - "type": "string", - "description": "Subnet Classless Inter-Domain Routing" - }, - "fqdn": { - "readOnly": true, - "type": "string", - "description": "Fully qualified domain name" - }, - "fqdnLastLookupTime": { - "readOnly": true, - "type": "string", - "format": "date-time", - "description": "FQDN last lookup time." - } - } - }, - "MacAddress": { - "type": "object", - "description": "MAC Address information", - "properties": { - "address": { - "readOnly": true, - "type": "string", - "description": "MAC address" - }, - "detectionTime": { - "readOnly": true, - "type": "string", - "format": "date-time", - "description": "Detection time of the mac address." - }, - "significance": { - "readOnly": true, - "type": "string", - "enum": [ - "Primary", - "Secondary" - ], - "x-ms-enum": { - "name": "MacSignificance", - "modelAsString": true - }, - "description": "Indicates whether this is the primary secondary MAC address of the device" - }, - "relationToIpStatus": { - "readOnly": true, - "type": "string", - "enum": [ - "Guess", - "Certain" - ], - "x-ms-enum": { - "name": "RelationToIpStatus", - "modelAsString": true - }, - "description": "Indicates whether the relation of the mac to the ip address is certain or a guess" - } - } - }, - "Firmware": { - "type": "object", - "description": "Firmware information", - "properties": { - "moduleAddress": { - "readOnly": true, - "type": "string", - "description": "Address of the specific module a firmware is related to" - }, - "rack": { - "readOnly": true, - "type": "string", - "description": "Rack number of the module a firmware is related to." - }, - "slot": { - "readOnly": true, - "type": "string", - "description": "Slot number in the rack of the module a firmware is related to" - }, - "serial": { - "readOnly": true, - "type": "string", - "description": "Serial of the firmware" - }, - "model": { - "readOnly": true, - "type": "string", - "description": "Firmware model" - }, - "version": { - "readOnly": true, - "type": "string", - "description": "Firmware version" - }, - "additionalData": { - "readOnly": true, - "type": "object", - "description": " A bag of fields which extends the firmware information." - } - } - }, - "Protocol": { - "type": "object", - "description": "Protocol data", - "properties": { - "name": { - "readOnly": true, - "type": "string", - "description": "Protocol name" - }, - "identifiers": { - "type": "string", - "description": "list of protocol identifiers." - } - } - }, - "Sensor": { - "type": "object", - "description": "Sensor data", - "properties": { - "name": { - "readOnly": true, - "type": "string", - "description": "Sensor name" - }, - "zone": { - "readOnly": true, - "type": "string", - "description": "Zone Name." - } - } - }, - "Site": { - "type": "object", - "description": "Site data", - "properties": { - "displayName": { - "readOnly": true, - "type": "string", - "description": "Site display name" - } - } - } - }, - "parameters": { - "DeviceId": { - "name": "deviceId", - "in": "path", - "required": true, - "description": "Identifier of the device.", - "type": "string", - "x-ms-parameter-location": "method" - } - } -} diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/Devices/GetDevice.json b/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/Devices/GetDevice.json deleted file mode 100644 index b90115600eb5..000000000000 --- a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/Devices/GetDevice.json +++ /dev/null @@ -1,79 +0,0 @@ -{ - "parameters": { - "api-version": "2020-08-06-preview", - "resourceId": "subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/MyGroup/providers/Microsoft.Devices/iotHubs/myHub", - "deviceId": "myDevice" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/MyGroup/providers/Microsoft.Devices/iotHubs/myHub/providers/Microsoft.Security/devices/myDevice", - "name": "myDevice", - "type": "Microsoft.Security/devices", - "properties": { - "displayName": "10.168.140.1", - "deviceType": "PLC", - "sourceName": "HORIZON", - "networkInterfaces": [ - { - "ipAddress": { - "v4Address": "10.168.140.1", - "detectionTime": "2020-05-13T06:32:25Z" - }, - "macAddress": { - "address": "34-E1-2D-77-80-D0", - "detectionTime": "2020-05-13T06:32:25Z", - "significance": "Primary", - "relationToIpStatus": "Certain" - }, - "vlans": [ - "name(1)->2", - "3", - "another_name(4)" - ] - } - ], - "vendor": "BROADCOM", - "osName": "Windows 10 64", - "protocols": [ - { - "name": "CIP", - "identifiers": "0, 1" - }, - { - "name": "EtherNet/IP", - "identifiers": "0, 1" - } - ], - "lastActiveTime": "2020-05-13T06:32:25Z", - "lastUpdateTime": "2020-05-13T06:32:25Z", - "managementState": "Unmanaged", - "authorizationState": "Authorized", - "deviceCriticality": "Standard", - "purdueLevel": "ProcessControl", - "firmwares": [ - { - "serial": "0x27269242", - "model": "1768-ENBT", - "version": "29.11" - } - ], - "discoveryTime": "2020-05-13T06:32:25Z", - "programmingState": "NotProgrammingDevice", - "scanningFunctionality": "NotScannerDevice", - "riskScore": 100, - "sensors": [ - { - "name": "mySensorName", - "zone": "myZoneName" - } - ], - "site": { - "displayName": "mySite" - }, - "deviceStatus": "Active" - } - } - } - } -} diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/Devices/GetDevicesListForHub.json b/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/Devices/GetDevicesListForHub.json deleted file mode 100644 index 777df993569e..000000000000 --- a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/Devices/GetDevicesListForHub.json +++ /dev/null @@ -1,82 +0,0 @@ -{ - "parameters": { - "api-version": "2020-08-06-preview", - "resourceId": "subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/MyGroup/providers/Microsoft.Devices/iotHubs/myHub" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/MyGroup/providers/Microsoft.Devices/iotHubs/myHub/providers/Microsoft.Security/devices/myDevice", - "name": "myDevice", - "type": "Microsoft.Security/devices", - "properties": { - "displayName": "10.168.140.1", - "deviceType": "PLC", - "sourceName": "HORIZON", - "networkInterfaces": [ - { - "ipAddress": { - "v4Address": "10.168.140.1", - "detectionTime": "2020-05-13T06:32:25Z" - }, - "macAddress": { - "address": "34-E1-2D-77-80-D0", - "detectionTime": "2020-05-13T06:32:25Z", - "significance": "Primary", - "relationToIpStatus": "Certain" - }, - "vlans": [ - "name(1)->2", - "3", - "another_name(4)" - ] - } - ], - "vendor": "BROADCOM", - "osName": "Windows 10 64", - "protocols": [ - { - "name": "CIP", - "identifiers": "0, 1" - }, - { - "name": "EtherNet/IP", - "identifiers": "0, 1" - } - ], - "lastActiveTime": "2020-05-13T06:32:25Z", - "lastUpdateTime": "2020-05-13T06:32:25Z", - "managementState": "Unmanaged", - "authorizationState": "Authorized", - "deviceCriticality": "Standard", - "purdueLevel": "ProcessControl", - "firmwares": [ - { - "serial": "0x27269242", - "model": "1768-ENBT", - "version": "29.11" - } - ], - "discoveryTime": "2020-05-13T06:32:25Z", - "programmingState": "NotProgrammingDevice", - "scanningFunctionality": "NotScannerDevice", - "riskScore": 100, - "sensors": [ - { - "name": "mySensorName", - "zone": "myZoneName" - } - ], - "site": { - "displayName": "mySite" - }, - "deviceStatus": "Active" - } - } - ] - } - } - } -} diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/Devices/GetDevicesListForSubscription.json b/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/Devices/GetDevicesListForSubscription.json deleted file mode 100644 index b4aca357ced5..000000000000 --- a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/Devices/GetDevicesListForSubscription.json +++ /dev/null @@ -1,82 +0,0 @@ -{ - "parameters": { - "api-version": "2020-08-06-preview", - "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/MyGroup/providers/Microsoft.Devices/iotHubs/myHub/providers/Microsoft.Security/devices/myDevice", - "name": "myDevice", - "type": "Microsoft.Security/devices", - "properties": { - "displayName": "10.168.140.1", - "deviceType": "PLC", - "sourceName": "HORIZON", - "networkInterfaces": [ - { - "ipAddress": { - "v4Address": "10.168.140.1", - "detectionTime": "2020-05-13T06:32:25Z" - }, - "macAddress": { - "address": "34-E1-2D-77-80-D0", - "detectionTime": "2020-05-13T06:32:25Z", - "significance": "Primary", - "relationToIpStatus": "Certain" - }, - "vlans": [ - "name(1)->2", - "3", - "another_name(4)" - ] - } - ], - "vendor": "BROADCOM", - "osName": "Windows 10 64", - "protocols": [ - { - "name": "CIP", - "identifiers": "0, 1" - }, - { - "name": "EtherNet/IP", - "identifiers": "0, 1" - } - ], - "lastActiveTime": "2020-05-13T06:32:25Z", - "lastUpdateTime": "2020-05-13T06:32:25Z", - "managementState": "Unmanaged", - "authorizationState": "Authorized", - "deviceCriticality": "Standard", - "purdueLevel": "ProcessControl", - "firmwares": [ - { - "serial": "0x27269242", - "model": "1768-ENBT", - "version": "29.11" - } - ], - "discoveryTime": "2020-05-13T06:32:25Z", - "programmingState": "NotProgrammingDevice", - "scanningFunctionality": "NotScannerDevice", - "riskScore": 100, - "sensors": [ - { - "name": "mySensorName", - "zone": "myZoneName" - } - ], - "site": { - "displayName": "mySite" - }, - "deviceStatus": "Active" - } - } - ] - } - } - } -} diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotAlertTypes/GetIoTAlertType.json b/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotAlertTypes/GetIoTAlertType.json deleted file mode 100644 index 87ce81ea38b0..000000000000 --- a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotAlertTypes/GetIoTAlertType.json +++ /dev/null @@ -1,29 +0,0 @@ -{ - "parameters": { - "api-version": "2020-08-06-preview", - "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", - "iotAlertTypeName": "IoT_PrivilegedContainer" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/iotAlertTypes/IoT_PrivilegedContainer", - "name": "IoT_PrivilegedContainer", - "type": "Microsoft.Security/iotAlertTypes", - "properties": { - "alertDisplayName": "Privileged container detected", - "severity": "Medium", - "description": "Machine logs indicate that a privileged Docker container is running. A privileged container has full access to host resources. If compromised, a malicious actor can use the privileged container to gain access to the host machine.", - "providerName": "IoTSecurity", - "remediationSteps": [ - "If the container doesn't need to run in privileged mode, remove the privileges from the container." - ], - "intent": "Exploitation,Execution", - "vendorName": "Microsoft", - "productName": "Azure Security Center for IoT", - "productComponentName": "IoT Hub" - } - } - } - } -} diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotAlertTypes/GetIoTAlertTypeList.json b/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotAlertTypes/GetIoTAlertTypeList.json deleted file mode 100644 index 80e82e38a730..000000000000 --- a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotAlertTypes/GetIoTAlertTypeList.json +++ /dev/null @@ -1,32 +0,0 @@ -{ - "parameters": { - "api-version": "2020-08-06-preview", - "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/iotAlertTypes", - "name": "IoT_PrivilegedContainer", - "type": "Microsoft.Security/iotAlertTypes", - "properties": { - "alertDisplayName": "Privileged container detected", - "severity": "Medium", - "description": "Machine logs indicate that a privileged Docker container is running. A privileged container has full access to host resources. If compromised, a malicious actor can use the privileged container to gain access to the host machine.", - "providerName": "IoTSecurity", - "remediationSteps": [ - "If the container doesn't need to run in privileged mode, remove the privileges from the container." - ], - "intent": "Exploitation,Execution", - "vendorName": "Microsoft", - "productName": "Azure Security Center for IoT", - "productComponentName": "IoT Hub" - } - } - ] - } - } - } -} diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotAlerts/GetIoTAlert.json b/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotAlerts/GetIoTAlert.json deleted file mode 100644 index 8412d3e4f6fd..000000000000 --- a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotAlerts/GetIoTAlert.json +++ /dev/null @@ -1,37 +0,0 @@ -{ - "parameters": { - "api-version": "2020-08-06-preview", - "scope": "subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myGroup/providers/Microsoft.Devices/IotHubs/myIotHub", - "iotAlertId": "903e76ff-17eb-4bac-ac8a-2bc31ab68fd8" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/MyGroup/providers/Microsoft.Devices/iotHubs/myIotHub/providers/Microsoft.Security/iotAlerts/903e76ff-17eb-4bac-ac8a-2bc31ab68fd8", - "name": "903e76ff-17eb-4bac-ac8a-2bc31ab68fd8", - "type": "Microsoft.Security/iotAlerts", - "properties": { - "systemAlertId": "903e76ff-17eb-4bac-ac8a-2bc31ab68fd8", - "compromisedEntity": "device-1", - "alertType": "IoT_PrivilegedContainer", - "startTimeUtc": "2020-05-13T06:32:25Z", - "endTimeUtc": "2020-05-13T06:32:25Z", - "entities": [ - { - "$id": "1", - "CommandLine": "docker run --privileged", - "Type": "process" - } - ], - "extendedProperties": { - "CommandLine": "docker run --privileged", - "User Name": "aUser", - "UserId": "", - "ParentProcessId": 1593, - "DeviceId": "device-1" - } - } - } - } - } -} diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotAlerts/GetIoTAlertList.json b/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotAlerts/GetIoTAlertList.json deleted file mode 100644 index 550b347860c5..000000000000 --- a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotAlerts/GetIoTAlertList.json +++ /dev/null @@ -1,46 +0,0 @@ -{ - "parameters": { - "api-version": "2020-08-06-preview", - "scope": "subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myGroup/providers/Microsoft.Devices/IotHubs/myIotHub", - "alertType": "IoT_PrivilegedContainer", - "startTimeUtc>": "2020-05-12T06:32:25Z", - "startTimeUtc<": "2020-05-14T06:32:25Z", - "compromisedEntity": "device-1", - "$limit": 1 - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/MyGroup/providers/Microsoft.Devices/iotHubs/myIotHub/providers/Microsoft.Security/iotAlerts/903e76ff-17eb-4bac-ac8a-2bc31ab68fd8", - "name": "903e76ff-17eb-4bac-ac8a-2bc31ab68fd8", - "type": "Microsoft.Security/iotAlerts", - "properties": { - "systemAlertId": "903e76ff-17eb-4bac-ac8a-2bc31ab68fd8", - "compromisedEntity": "device-1", - "alertType": "IoT_PrivilegedContainer", - "startTimeUtc": "2020-05-13T06:32:25Z", - "endTimeUtc": "2020-05-13T06:32:25Z", - "entities": [ - { - "$id": "1", - "CommandLine": "docker run --privileged", - "Type": "process" - } - ], - "extendedProperties": { - "CommandLine": "docker run --privileged", - "User Name": "aUser", - "UserId": "", - "ParentProcessId": 1593, - "DeviceId": "device-1" - } - } - } - ], - "nextLink": "https://management.azure.com/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myGroup/providers/Microsoft.Devices/iotHubs/myIotHub/providers/Microsoft.Security/iotAlerts?api-version=2020-08-06-preview&alertType=IoT_PrivilegedContainer&startTimeUtc>=2020-05-12T06:32:25Z&startTimeUtc<=2020-05-14T06:32:25Z&compromisedEntity=device-1&$limit=1&$skipToken=903e76ff-17eb-4bac-ac8a-2bc31ab68fd8" - } - } - } -} diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotDefenderSettings/Delete.json b/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotDefenderSettings/Delete.json deleted file mode 100644 index 1e27394b4322..000000000000 --- a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotDefenderSettings/Delete.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "parameters": { - "api-version": "2020-08-06-preview", - "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23" - }, - "responses": { - "200": {}, - "204": {} - } -} diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotDefenderSettings/DownloadManagerActivation.json b/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotDefenderSettings/DownloadManagerActivation.json deleted file mode 100644 index 2063852d8dd6..000000000000 --- a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotDefenderSettings/DownloadManagerActivation.json +++ /dev/null @@ -1,14 +0,0 @@ -{ - "parameters": { - "api-version": "2020-08-06-preview", - "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23" - }, - "responses": { - "200": { - "headers": { - "content-type": "application/zip" - }, - "body": "{Binary}" - } - } -} diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotDefenderSettings/Get.json b/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotDefenderSettings/Get.json deleted file mode 100644 index a2c048ddca11..000000000000 --- a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotDefenderSettings/Get.json +++ /dev/null @@ -1,23 +0,0 @@ -{ - "parameters": { - "api-version": "2020-08-06-preview", - "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23" - }, - "responses": { - "200": { - "body": { - "name": "default", - "id": "/subscriptions/{subscriptionId}/providers/Microsoft.Security/iotDefenderSettings/default", - "type": "Microsoft.Security/iotDefenderSettings", - "properties": { - "deviceQuota": 2000, - "sentinelWorkspaceResourceIds": [ - "/subscriptions/c4930e90-cd72-4aa5-93e9-2d081d129569/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace1" - ], - "onboardingKind": "Evaluation", - "evaluationEndTime": "2021-06-29T00:00:00.0000000Z" - } - } - } - } -} diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotDefenderSettings/List.json b/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotDefenderSettings/List.json deleted file mode 100644 index d4fed0f881c6..000000000000 --- a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotDefenderSettings/List.json +++ /dev/null @@ -1,26 +0,0 @@ -{ - "parameters": { - "api-version": "2020-08-06-preview", - "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "name": "default", - "id": "/subscriptions/{subscriptionId}/providers/Microsoft.Security/iotDefenderSettings/default", - "type": "Microsoft.Security/iotDefenderSettings", - "properties": { - "deviceQuota": 2000, - "sentinelWorkspaceResourceIds": [ - "/subscriptions/c4930e90-cd72-4aa5-93e9-2d081d129569/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace1" - ], - "onboardingKind": "Default" - } - } - ] - } - } - } -} diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotDefenderSettings/PackageDownloads.json b/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotDefenderSettings/PackageDownloads.json deleted file mode 100644 index 456dc61d0672..000000000000 --- a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotDefenderSettings/PackageDownloads.json +++ /dev/null @@ -1,170 +0,0 @@ -{ - "parameters": { - "api-version": "2020-08-06-preview", - "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23" - }, - "responses": { - "200": { - "body": { - "sensor": { - "full": { - "iso": [ - { - "version": "3.1", - "link": "http://microsoft.com/downloadLocation", - "versionKind": "Latest" - }, - { - "version": "2.8.11", - "link": "http://microsoft.com/downloadLocation", - "versionKind": "Previous" - } - ], - "ovf": { - "enterprise": [ - { - "version": "3.1", - "link": "http://microsoft.com/downloadLocation", - "versionKind": "Latest" - }, - { - "version": "2.8.11", - "link": "http://microsoft.com/downloadLocation", - "versionKind": "Previous" - } - ], - "medium": [ - { - "version": "3.1", - "link": "http://microsoft.com/downloadLocation", - "versionKind": "Latest" - }, - { - "version": "2.8.11", - "link": "http://microsoft.com/downloadLocation", - "versionKind": "Previous" - } - ], - "line": [ - { - "version": "3.1", - "link": "http://microsoft.com/downloadLocation", - "versionKind": "Latest" - }, - { - "version": "2.8.11", - "link": "http://microsoft.com/downloadLocation", - "versionKind": "Previous" - } - ] - } - }, - "upgrade": [ - { - "version": "2.8.2", - "fromVersion": "2.8.0", - "link": "http://microsoft.com/downloadLocation", - "versionKind": "Latest" - }, - { - "version": "2.8.10", - "fromVersion": "2.8.0", - "link": "http://microsoft.com/downloadLocation", - "versionKind": "Previous" - } - ] - }, - "centralManager": { - "full": { - "iso": [ - { - "version": "3.1", - "link": "http://microsoft.com/downloadLocation", - "versionKind": "Latest" - }, - { - "version": "2.8.11", - "link": "http://microsoft.com/downloadLocation", - "versionKind": "Previous" - } - ], - "ovf": { - "enterprise": [ - { - "version": "3.1", - "link": "http://microsoft.com/downloadLocation", - "versionKind": "Latest" - } - ], - "enterpriseHighAvailability": [ - { - "version": "3.1", - "link": "http://microsoft.com/downloadLocation", - "versionKind": "Latest" - } - ], - "medium": [ - { - "version": "3.1", - "link": "http://microsoft.com/downloadLocation", - "versionKind": "Latest" - } - ], - "mediumHighAvailability": [ - { - "version": "3.1", - "link": "http://microsoft.com/downloadLocation", - "versionKind": "Latest" - } - ] - } - }, - "upgrade": [ - { - "version": "2.8.2", - "fromVersion": "2.8.0", - "link": "http://microsoft.com/downloadLocation", - "versionKind": "Latest" - }, - { - "version": "2.8.10", - "fromVersion": "2.8.0", - "link": "http://microsoft.com/downloadLocation", - "versionKind": "Previous" - } - ] - }, - "threatIntelligence": [ - { - "link": "http://microsoft.com/downloadLocation", - "version": "2020.02.10" - } - ], - "snmp": [ - { - "link": "http://microsoft.com/downloadLocation", - "version": "2020.02.10" - } - ], - "wmiTool": [ - { - "link": "http://microsoft.com/downloadLocation", - "version": "2020.02.10" - } - ], - "authorizedDevicesImportTemplate": [ - { - "link": "http://microsoft.com/downloadLocation", - "version": "2020.02.10" - } - ], - "deviceInformationUpdateImportTemplate": [ - { - "link": "http://microsoft.com/downloadLocation", - "version": "2020.02.10" - } - ] - } - } - } -} diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotDefenderSettings/Put.json b/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotDefenderSettings/Put.json deleted file mode 100644 index e4c54697eab3..000000000000 --- a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotDefenderSettings/Put.json +++ /dev/null @@ -1,45 +0,0 @@ -{ - "parameters": { - "api-version": "2020-08-06-preview", - "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", - "iotDefenderSettingsModel": { - "properties": { - "deviceQuota": 2000, - "sentinelWorkspaceResourceIds": [ - "/subscriptions/c4930e90-cd72-4aa5-93e9-2d081d129569/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace1" - ], - "onboardingKind": "Default" - } - } - }, - "responses": { - "200": { - "body": { - "name": "default", - "id": "/subscriptions/{subscriptionId}/providers/Microsoft.Security/iotDefenderSettings/default", - "type": "Microsoft.Security/iotDefenderSettings", - "properties": { - "deviceQuota": 2000, - "sentinelWorkspaceResourceIds": [ - "/subscriptions/c4930e90-cd72-4aa5-93e9-2d081d129569/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace1" - ], - "onboardingKind": "Default" - } - } - }, - "201": { - "body": { - "name": "default", - "id": "/subscriptions/{subscriptionId}/providers/Microsoft.Security/iotDefenderSettings/default", - "type": "Microsoft.Security/iotDefenderSettings", - "properties": { - "deviceQuota": 2000, - "sentinelWorkspaceResourceIds": [ - "/subscriptions/c4930e90-cd72-4aa5-93e9-2d081d129569/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace1" - ], - "onboardingKind": "Default" - } - } - } - } -} diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotRecommendationTypes/GetIoTRecommendationType.json b/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotRecommendationTypes/GetIoTRecommendationType.json deleted file mode 100644 index ecc8b4b4b15e..000000000000 --- a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotRecommendationTypes/GetIoTRecommendationType.json +++ /dev/null @@ -1,28 +0,0 @@ -{ - "parameters": { - "api-version": "2020-08-06-preview", - "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", - "iotRecommendationTypeName": "IoT_VulnerableTLSCipherSuite" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/iotRecommendationTypes/IoT_VulnerableTLSCipherSuite", - "name": "IoT_VulnerableTLSCipherSuite", - "type": "Microsoft.Security/iotRecommendationTypes", - "properties": { - "recommendationDisplayName": "TLS cipher suite upgrade needed", - "severity": "Medium", - "description": "Insecure TLS configurations detected. Immediate TLS cipher suite upgrade recommended.", - "remediationSteps": [ - "Upgrade your TLS cipher suite to a secure configuration. See the Guide to TLS Standards Compliance for more information." - ], - "vendorName": "Microsoft", - "control": "Communication between device and IoT Hub is not optimized", - "productName": "Azure Security Center for IoT", - "productComponentName": "IoT Hub" - } - } - } - } -} diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotRecommendationTypes/GetIoTRecommendationTypeList.json b/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotRecommendationTypes/GetIoTRecommendationTypeList.json deleted file mode 100644 index ba7a86b41b0b..000000000000 --- a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotRecommendationTypes/GetIoTRecommendationTypeList.json +++ /dev/null @@ -1,31 +0,0 @@ -{ - "parameters": { - "api-version": "2020-08-06-preview", - "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/iotRecommendationTypes/IoT_VulnerableTLSCipherSuite", - "name": "IoT_VulnerableTLSCipherSuite", - "type": "Microsoft.Security/iotRecommendationTypes", - "properties": { - "recommendationDisplayName": "TLS cipher suite upgrade needed", - "severity": "Medium", - "description": "Insecure TLS configurations detected. Immediate TLS cipher suite upgrade recommended.", - "remediationSteps": [ - "Upgrade your TLS cipher suite to a secure configuration. See the Guide to TLS Standards Compliance for more information." - ], - "vendorName": "Microsoft", - "control": "Communication between device and IoT Hub is not optimized", - "productName": "Azure Security Center for IoT", - "productComponentName": "IoT Hub" - } - } - ] - } - } - } -} diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotRecommendations/GetIoTRecommendation.json b/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotRecommendations/GetIoTRecommendation.json deleted file mode 100644 index 4c12cfdae65b..000000000000 --- a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotRecommendations/GetIoTRecommendation.json +++ /dev/null @@ -1,27 +0,0 @@ -{ - "parameters": { - "api-version": "2020-08-06-preview", - "scope": "subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myGroup/providers/Microsoft.Devices/IotHubs/myIotHub", - "iotRecommendationId": "903e76ff-17eb-4bac-ac8a-2bc31ab68fd8" - }, - "responses": { - "200": { - "body": { - "name": "IoT_Baseline|device-1", - "properties": { - "recommendationType": "IoT_Baseline", - "deviceId": "device-1", - "discoveredTimeUtc": "2020-05-13T06:32:25Z", - "recommendationAdditionalData": { - "SnapshotId": "48519d58-4e35-46cd-aed5-6251af95ed50", - "TotalFailedRules": "7", - "TotalRulesFailedDuoToError": "1", - "TotalInformationalFailedRules": "2", - "TotalCriticalFailedRules": "3", - "TotalWarningFailedRules": "1" - } - } - } - } - } -} diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotRecommendations/GetIoTRecommendationList.json b/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotRecommendations/GetIoTRecommendationList.json deleted file mode 100644 index b6f909d395bc..000000000000 --- a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotRecommendations/GetIoTRecommendationList.json +++ /dev/null @@ -1,34 +0,0 @@ -{ - "parameters": { - "api-version": "2020-08-06-preview", - "scope": "subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myGroup/providers/Microsoft.Devices/IotHubs/myIotHub", - "recommendationType": "IoT_Baseline", - "deviceId": "device-1", - "$limit": 1 - }, - "responses": { - "200": { - "body": { - "value": [ - { - "name": "IoT_Baseline|device-1", - "properties": { - "recommendationType": "IoT_Baseline", - "deviceId": "device-1", - "discoveredTimeUtc": "2020-05-13T06:32:25Z", - "recommendationAdditionalData": { - "SnapshotId": "48519d58-4e35-46cd-aed5-6251af95ed50", - "TotalFailedRules": "7", - "TotalRulesFailedDuoToError": "1", - "TotalInformationalFailedRules": "2", - "TotalCriticalFailedRules": "3", - "TotalWarningFailedRules": "1" - } - } - } - ], - "nextLink": "https://management.azure.com/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myGroup/providers/Microsoft.Devices/iotHubs/myIotHub/providers/Microsoft.Security/iotRecommendations?api-version=2020-08-06-preview&recommendationType=IoT_Baseline&deviceId=device-1&$limit=1&$skipToken=903e76ff-17eb-4bac-ac8a-2bc31ab68fd8" - } - } - } -} diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/OnPremiseIotSensors/Get.json b/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/OnPremiseIotSensors/Get.json deleted file mode 100644 index e504ee9a9086..000000000000 --- a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/OnPremiseIotSensors/Get.json +++ /dev/null @@ -1,17 +0,0 @@ -{ - "parameters": { - "api-version": "2020-08-06-preview", - "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", - "onPremiseIotSensorName": "mySensor" - }, - "responses": { - "200": { - "body": { - "name": "mySensor", - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/onPremiseIotSensors/mySensor", - "type": "Microsoft.Security/onPremiseIotSensors", - "properties": {} - } - } - } -} diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/OnPremiseIotSensors/List.json b/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/OnPremiseIotSensors/List.json deleted file mode 100644 index f2536dd92897..000000000000 --- a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/OnPremiseIotSensors/List.json +++ /dev/null @@ -1,26 +0,0 @@ -{ - "parameters": { - "api-version": "2020-08-06-preview", - "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "name": "mySensor", - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/iotSensors/mySensor", - "type": "Microsoft.Security/onPremiseIotSensors", - "properties": {} - }, - { - "name": "otherSensor", - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/iotSensors/otherSensor", - "type": "Microsoft.Security/onPremiseIotSensors", - "properties": {} - } - ] - } - } - } -} diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/OnPremiseIotSensors/Put.json b/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/OnPremiseIotSensors/Put.json deleted file mode 100644 index 80f3d877d6d4..000000000000 --- a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/OnPremiseIotSensors/Put.json +++ /dev/null @@ -1,25 +0,0 @@ -{ - "parameters": { - "api-version": "2020-08-06-preview", - "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", - "onPremiseIotSensorName": "mySensor" - }, - "responses": { - "200": { - "body": { - "name": "mySensor", - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/iotSensors/mySensor", - "type": "Microsoft.Security/onPremiseIotSensors", - "properties": {} - } - }, - "201": { - "body": { - "name": "mySensor", - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/iotSensors/mySensor", - "type": "Microsoft.Security/onPremiseIotSensors", - "properties": {} - } - } - } -} diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/iotAlertTypes.json b/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/iotAlertTypes.json deleted file mode 100644 index a1dd8e2d4361..000000000000 --- a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/iotAlertTypes.json +++ /dev/null @@ -1,307 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "Security Center", - "description": "API spec for Microsoft.Security (Azure Security Center) resource provider", - "version": "2020-08-06-preview" - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ], - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Azure Active Directory OAuth2 Flow", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "paths": { - "/subscriptions/{subscriptionId}/providers/Microsoft.Security/iotAlertTypes": { - "get": { - "x-ms-examples": { - "Get IoT Alert Types": { - "$ref": "./examples/IotAlertTypes/GetIoTAlertTypeList.json" - } - }, - "tags": [ - "IoT Security Alert Types" - ], - "description": "List IoT alert types", - "operationId": "IotAlertTypes_List", - "parameters": [ - { - "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/IotAlertTypeList" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/definitions/CloudError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Security/iotAlertTypes/{iotAlertTypeName}": { - "get": { - "x-ms-examples": { - "Get IoT Alert Type": { - "$ref": "./examples/IotAlertTypes/GetIoTAlertType.json" - } - }, - "tags": [ - "IoT Security Alert Types" - ], - "operationId": "IotAlertTypes_Get", - "description": "Get IoT alert type", - "parameters": [ - { - "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" - }, - { - "in": "path", - "name": "iotAlertTypeName", - "required": true, - "type": "string", - "description": "Name of the alert type" - } - ], - "responses": { - "200": { - "description": "IoT alert type", - "schema": { - "$ref": "#/definitions/IotAlertType" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/definitions/CloudError" - } - } - } - } - } - }, - "definitions": { - "IotAlertTypeList": { - "type": "object", - "description": "List of alert types", - "properties": { - "value": { - "type": "array", - "description": "List data", - "items": { - "$ref": "#/definitions/IotAlertType" - } - } - } - }, - "IotAlertType": { - "type": "object", - "description": "IoT alert type.", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "description": "Alert type properties", - "$ref": "#/definitions/IotAlertTypeProperties" - } - }, - "allOf": [ - { - "$ref": "../../../common/v1/types.json#/definitions/Resource" - } - ] - }, - "IotAlertTypeProperties": { - "type": "object", - "description": "IoT alert type information.", - "properties": { - "alertDisplayName": { - "readOnly": true, - "type": "string", - "example": "Privileged container detected", - "description": "The display name of the alert" - }, - "severity": { - "readOnly": true, - "type": "string", - "example": "Medium", - "description": "The severity of the alert", - "enum": [ - "Informational", - "Low", - "Medium", - "High" - ], - "x-ms-enum": { - "name": "alertSeverity", - "modelAsString": true, - "values": [ - { - "value": "Informational" - }, - { - "value": "Low" - }, - { - "value": "Medium" - }, - { - "value": "High" - } - ] - } - }, - "description": { - "readOnly": true, - "type": "string", - "description": "Description of the suspected vulnerability and meaning.", - "example": "Machine logs indicate that a privileged Docker container is running. A privileged container has full access to host resources. If compromised, a malicious actor can use the privileged container to gain access to the host machine." - }, - "providerName": { - "readOnly": true, - "type": "string", - "example": "IoTSecurity", - "description": "The name of the alert provider or internal partner" - }, - "productName": { - "readOnly": true, - "type": "string", - "example": "Azure Security Center for IoT", - "description": "The name of the product which published this alert" - }, - "productComponentName": { - "readOnly": true, - "type": "string", - "example": "IoT Hub", - "description": "The name of a component inside the product which generated the alert" - }, - "vendorName": { - "readOnly": true, - "type": "string", - "example": "Microsoft", - "description": "The name of the vendor that raise the alert" - }, - "intent": { - "readOnly": true, - "type": "string", - "example": "Exploitation,Execution", - "description": "Kill chain related intent behind the alert. Could contain multiple enum values (separated by commas)", - "enum": [ - "Unknown", - "PreAttack", - "InitialAccess", - "Persistence", - "PrivilegeEscalation", - "DefenseEvasion", - "CredentialAccess", - "Discovery", - "LateralMovement", - "Execution", - "Collection", - "Exfiltration", - "CommandAndControl", - "Impact", - "Probing", - "Exploitation" - ], - "x-ms-enum": { - "name": "alertIntent", - "modelAsString": true, - "values": [ - { - "value": "Unknown" - }, - { - "value": "PreAttack" - }, - { - "value": "InitialAccess" - }, - { - "value": "Persistence" - }, - { - "value": "PrivilegeEscalation" - }, - { - "value": "DefenseEvasion" - }, - { - "value": "CredentialAccess" - }, - { - "value": "Discovery" - }, - { - "value": "LateralMovement" - }, - { - "value": "Execution" - }, - { - "value": "Collection" - }, - { - "value": "Exfiltration" - }, - { - "value": "CommandAndControl" - }, - { - "value": "Impact" - }, - { - "value": "Probing" - }, - { - "value": "Exploitation" - } - ] - } - }, - "remediationSteps": { - "readOnly": true, - "description": "Manual action items to take to remediate the alert", - "type": "array", - "items": { - "type": "string", - "example": "If the container doesn't need to run in privileged mode, remove the privileges from the container." - } - } - } - } - } -} diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/iotAlerts.json b/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/iotAlerts.json deleted file mode 100644 index bdf74b5bb257..000000000000 --- a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/iotAlerts.json +++ /dev/null @@ -1,289 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "Security Center", - "description": "API spec for Microsoft.Security (Azure Security Center) resource provider", - "version": "2020-08-06-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": { - "/{scope}/providers/Microsoft.Security/iotAlerts": { - "get": { - "x-ms-examples": { - "List IoT Alerts": { - "$ref": "./examples/IotAlerts/GetIoTAlertList.json" - } - }, - "tags": [ - "IoT Security Alerts" - ], - "description": "List IoT alerts", - "operationId": "IotAlerts_List", - "parameters": [ - { - "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/IotAlertScope" - }, - { - "in": "query", - "name": "startTimeUtc>", - "x-ms-client-name": "minStartTimeUtc", - "required": false, - "type": "string", - "description": "Filter by minimum startTimeUtc (ISO 8601 format)" - }, - { - "in": "query", - "name": "startTimeUtc<", - "x-ms-client-name": "maxStartTimeUtc", - "required": false, - "type": "string", - "description": "Filter by maximum startTimeUtc (ISO 8601 format)" - }, - { - "in": "query", - "name": "alertType", - "required": false, - "type": "string", - "description": "Filter by alert type" - }, - { - "in": "query", - "name": "deviceManagementType", - "required": false, - "type": "string", - "enum": [ - "Managed", - "Unmanaged" - ], - "description": "Get devices only from specific type, Managed or Unmanaged.", - "x-ms-enum": { - "name": "ManagementState", - "modelAsString": true - } - }, - { - "in": "query", - "name": "compromisedEntity", - "required": false, - "type": "string", - "description": "Filter by compromised device" - }, - { - "in": "query", - "name": "$limit", - "required": false, - "type": "integer", - "format": "int32", - "description": "Limit the number of items returned in a single page" - }, - { - "in": "query", - "name": "$skipToken", - "required": false, - "type": "string", - "description": "Skip token used for pagination" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/IotAlertListModel" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/definitions/CloudError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/{scope}/providers/Microsoft.Security/iotAlerts/{iotAlertId}": { - "get": { - "x-ms-examples": { - "Get IoT Alert": { - "$ref": "./examples/IotAlerts/GetIoTAlert.json" - } - }, - "tags": [ - "IoT Security Alerts" - ], - "operationId": "IotAlerts_Get", - "description": "Get IoT alert", - "parameters": [ - { - "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/IotAlertScope" - }, - { - "in": "path", - "name": "iotAlertId", - "required": true, - "type": "string", - "description": "Id of the alert" - } - ], - "responses": { - "200": { - "description": "IoT alert", - "schema": { - "$ref": "#/definitions/IotAlertModel" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/definitions/CloudError" - } - } - } - } - } - }, - "definitions": { - "IotAlertListModel": { - "description": "List of IoT alerts", - "type": "object", - "properties": { - "value": { - "description": "List data", - "readOnly": true, - "type": "array", - "items": { - "$ref": "#/definitions/IotAlertModel" - } - }, - "nextLink": { - "readOnly": true, - "type": "string", - "description": "When available, follow the URI to get the next page of data" - } - } - }, - "IotAlertModel": { - "type": "object", - "description": "IoT alert", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "description": "Alert properties", - "$ref": "#/definitions/IotAlertPropertiesModel" - } - }, - "allOf": [ - { - "$ref": "../../../common/v1/types.json#/definitions/Resource" - } - ] - }, - "IotAlertPropertiesModel": { - "type": "object", - "description": "IoT alert properties", - "properties": { - "systemAlertId": { - "description": "Holds the product canonical identifier of the alert within the scope of a product", - "readOnly": true, - "type": "string", - "example": "903e76ff-17eb-4bac-ac8a-2bc31ab68fd8" - }, - "compromisedEntity": { - "description": "Display name of the main entity being reported on", - "readOnly": true, - "type": "string", - "example": "device-1" - }, - "alertType": { - "description": "The type name of the alert", - "readOnly": true, - "type": "string", - "example": "IoT_PrivilegedContainer" - }, - "startTimeUtc": { - "description": "The impact start time of the alert (the time of the first event or activity included in the alert)", - "readOnly": true, - "type": "string", - "example": "2020-05-13T06:32:25Z" - }, - "endTimeUtc": { - "description": "The impact end time of the alert (the time of the last event or activity included in the alert)", - "readOnly": true, - "type": "string", - "example": "2020-05-13T06:32:25Z" - }, - "entities": { - "description": "A list of entities related to the alert", - "type": "array", - "items": { - "type": "object" - }, - "example": [ - { - "$id": "1", - "CommandLine": "docker run --privileged", - "Type": "process" - } - ] - }, - "extendedProperties": { - "type": "object", - "description": "A bag of fields which extends the alert information", - "example": { - "CommandLine": "docker run --privileged", - "User Name": "aUser", - "UserId": "", - "ParentProcessId": 1593, - "DeviceId": "device-1" - } - } - } - } - }, - "parameters": { - "IotAlertScope": { - "name": "scope", - "in": "path", - "required": true, - "type": "string", - "description": "Scope of the query: Subscription (i.e. /subscriptions/{subscriptionId}) or IoT Hub (i.e. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Devices/iotHubs/{iotHubName})", - "x-ms-parameter-location": "method", - "x-ms-skip-url-encoding": true - } - } -} diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/iotDefenderSettings.json b/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/iotDefenderSettings.json deleted file mode 100644 index ae50e311f50a..000000000000 --- a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/iotDefenderSettings.json +++ /dev/null @@ -1,587 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "Security Center", - "description": "API spec for Microsoft.Security (Azure Security Center) resource provider", - "version": "2020-08-06-preview" - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ], - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Azure Active Directory OAuth2 Flow", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "paths": { - "/subscriptions/{subscriptionId}/providers/Microsoft.Security/iotDefenderSettings": { - "get": { - "x-ms-examples": { - "List IoT Defender settings": { - "$ref": "./examples/IotDefenderSettings/List.json" - } - }, - "tags": [ - "IoT Defender Settings" - ], - "description": "List IoT Defender Settings", - "operationId": "IotDefenderSettings_List", - "parameters": [ - { - "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/IotDefenderSettingsList" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/definitions/CloudError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Security/iotDefenderSettings/default": { - "get": { - "x-ms-examples": { - "Get IoT Defender settings": { - "$ref": "./examples/IotDefenderSettings/Get.json" - } - }, - "tags": [ - "IoT Defender Settings" - ], - "operationId": "IotDefenderSettings_Get", - "description": "Get IoT Defender Settings", - "parameters": [ - { - "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" - } - ], - "responses": { - "200": { - "description": "IoT Defender Settings", - "schema": { - "$ref": "#/definitions/IotDefenderSettingsModel" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/definitions/CloudError" - } - } - } - }, - "put": { - "x-ms-examples": { - "Create or update IoT Defender settings": { - "$ref": "./examples/IotDefenderSettings/Put.json" - } - }, - "tags": [ - "IoT Defender Settings" - ], - "operationId": "IotDefenderSettings_CreateOrUpdate", - "description": "Create or update IoT Defender settings", - "parameters": [ - { - "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" - }, - { - "$ref": "#/parameters/IotDefenderSettingsModel" - } - ], - "responses": { - "200": { - "description": "Updated IoT Defender settings", - "schema": { - "$ref": "#/definitions/IotDefenderSettingsModel" - } - }, - "201": { - "description": "Created IoT Defender settings", - "schema": { - "$ref": "#/definitions/IotDefenderSettingsModel" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/definitions/CloudError" - } - } - } - }, - "delete": { - "x-ms-examples": { - "Delete IoT Defender settings": { - "$ref": "./examples/IotDefenderSettings/Delete.json" - } - }, - "tags": [ - "IoT Defender Settings" - ], - "operationId": "IotDefenderSettings_Delete", - "description": "Delete IoT Defender settings", - "parameters": [ - { - "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" - } - ], - "responses": { - "200": { - "description": "IoT Defender settings deleted" - }, - "204": { - "description": "IoT Defender settings does not exist" - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/definitions/CloudError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Security/iotDefenderSettings/default/packageDownloads": { - "post": { - "x-ms-examples": { - "Package downloads": { - "$ref": "./examples/IotDefenderSettings/PackageDownloads.json" - } - }, - "tags": [ - "IoT Defender Settings" - ], - "operationId": "IotDefenderSettings_PackageDownloads", - "description": "Information about downloadable packages", - "parameters": [ - { - "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" - } - ], - "responses": { - "200": { - "description": "Package downloads", - "schema": { - "$ref": "#/definitions/PackageDownloads" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/definitions/CloudError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Security/iotDefenderSettings/default/downloadManagerActivation": { - "post": { - "x-ms-examples": { - "Download quota data of the subscription": { - "$ref": "./examples/IotDefenderSettings/DownloadManagerActivation.json" - } - }, - "tags": [ - "IoT Defender Settings" - ], - "operationId": "IotDefenderSettings_DownloadManagerActivation", - "description": "Download manager activation data defined for this subscription", - "parameters": [ - { - "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" - } - ], - "produces": [ - "application/zip" - ], - "responses": { - "200": { - "description": "Downloaded file", - "schema": { - "type": "object", - "format": "file" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/definitions/CloudError" - } - } - } - } - } - }, - "definitions": { - "IotDefenderSettingsList": { - "description": "List of IoT Defender settings", - "type": "object", - "properties": { - "value": { - "description": "List data", - "readOnly": true, - "type": "array", - "items": { - "$ref": "#/definitions/IotDefenderSettingsModel" - } - } - } - }, - "IotDefenderSettingsModel": { - "type": "object", - "description": "IoT Defender settings", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "description": "IoT Defender settings properties", - "$ref": "#/definitions/IotDefenderSettingsProperties" - } - }, - "allOf": [ - { - "$ref": "../../../common/v1/types.json#/definitions/Resource" - } - ] - }, - "IotDefenderSettingsProperties": { - "type": "object", - "description": "IoT Defender settings properties", - "properties": { - "deviceQuota": { - "type": "integer", - "format": "int32", - "minimum": 1000, - "description": "Size of the device quota (as a opposed to a Pay as You Go billing model). Value is required to be in multiples of 1000." - }, - "sentinelWorkspaceResourceIds": { - "type": "array", - "description": "Sentinel Workspace Resource Ids", - "items": { - "type": "string" - } - }, - "onboardingKind": { - "type": "string", - "enum": [ - "Default", - "MigratedToAzure", - "Evaluation", - "Purchased" - ], - "description": "The kind of onboarding for the subscription", - "x-ms-enum": { - "name": "OnboardingKind", - "modelAsString": true - } - }, - "evaluationEndTime": { - "type": "string", - "format": "date-time", - "description": "End time of the evaluation period, if such exist", - "readOnly": true - } - }, - "required": [ - "deviceQuota", - "sentinelWorkspaceResourceIds", - "onboardingKind" - ] - }, - "DownloadLink": { - "type": "string", - "description": "Download link", - "readOnly": true - }, - "PackageDownloadInfo": { - "type": "object", - "description": "Information on a specific package download", - "properties": { - "version": { - "type": "string", - "description": "Version number", - "readOnly": true - }, - "link": { - "description": "Download link", - "$ref": "#/definitions/DownloadLink" - }, - "versionKind": { - "type": "string", - "description": "Kind of the version", - "readOnly": true, - "enum": [ - "Latest", - "Previous", - "Preview" - ], - "x-ms-enum": { - "name": "versionKind", - "modelAsString": true, - "values": [ - { - "value": "Latest" - }, - { - "value": "Previous" - }, - { - "value": "Preview" - } - ] - } - } - } - }, - "UpgradePackageDownloadInfo": { - "type": "object", - "description": "Information on a specific package upgrade download", - "properties": { - "fromVersion": { - "type": "string", - "description": "Minimum base version for upgrade", - "readOnly": true - } - }, - "allOf": [ - { - "$ref": "#/definitions/PackageDownloadInfo" - } - ] - }, - "PackageDownloads": { - "type": "object", - "description": "Information about package downloads", - "readOnly": true, - "properties": { - "sensor": { - "type": "object", - "description": "Contains all Sensor binary downloads", - "readOnly": true, - "properties": { - "full": { - "type": "object", - "description": "Contains full package downloads", - "readOnly": true, - "properties": { - "iso": { - "type": "array", - "description": "Contains all ISO full versions for the sensor", - "readOnly": true, - "items": { - "$ref": "#/definitions/PackageDownloadInfo" - } - }, - "ovf": { - "type": "object", - "description": "Contains all OVF (virtual machine) full versions for the sensor", - "properties": { - "enterprise": { - "type": "array", - "description": "Enterprise package type", - "readOnly": true, - "items": { - "$ref": "#/definitions/PackageDownloadInfo" - } - }, - "medium": { - "type": "array", - "description": "Medium package type", - "readOnly": true, - "items": { - "$ref": "#/definitions/PackageDownloadInfo" - } - }, - "line": { - "type": "array", - "description": "Line package type", - "readOnly": true, - "items": { - "$ref": "#/definitions/PackageDownloadInfo" - } - } - } - } - } - }, - "upgrade": { - "type": "array", - "description": "Sensor upgrade package downloads (on existing installations)", - "items": { - "$ref": "#/definitions/UpgradePackageDownloadInfo" - } - } - } - }, - "centralManager": { - "type": "object", - "description": "All downloads for Central Manager", - "readOnly": true, - "properties": { - "full": { - "type": "object", - "description": "Contains full package downloads", - "readOnly": true, - "properties": { - "iso": { - "type": "array", - "description": "Contains all ISO full versions of the Central Manager", - "readOnly": true, - "items": { - "$ref": "#/definitions/PackageDownloadInfo" - } - }, - "ovf": { - "type": "object", - "description": "Contains all OVF (virtual machine) full versions of the Central Manager", - "readOnly": true, - "properties": { - "enterprise": { - "type": "array", - "description": "The Enterprise package type", - "readOnly": true, - "items": { - "$ref": "#/definitions/PackageDownloadInfo" - } - }, - "enterpriseHighAvailability": { - "type": "array", - "description": "The EnterpriseHighAvailability package type", - "readOnly": true, - "items": { - "$ref": "#/definitions/PackageDownloadInfo" - } - }, - "medium": { - "type": "array", - "description": "The Medium package type", - "readOnly": true, - "items": { - "$ref": "#/definitions/PackageDownloadInfo" - } - }, - "mediumHighAvailability": { - "type": "array", - "description": "The MediumHighAvailability package type", - "readOnly": true, - "items": { - "$ref": "#/definitions/PackageDownloadInfo" - } - } - } - } - } - }, - "upgrade": { - "type": "array", - "description": "Central Manager upgrade package downloads (on existing installations)", - "readOnly": true, - "items": { - "$ref": "#/definitions/UpgradePackageDownloadInfo" - } - } - } - }, - "threatIntelligence": { - "type": "array", - "description": "All downloads for threat intelligence", - "readOnly": true, - "items": { - "$ref": "#/definitions/PackageDownloadInfo" - } - }, - "snmp": { - "type": "array", - "description": "SNMP Server file", - "readOnly": true, - "items": { - "$ref": "#/definitions/PackageDownloadInfo" - } - }, - "wmiTool": { - "type": "array", - "description": "Used for local configuration export", - "readOnly": true, - "items": { - "$ref": "#/definitions/PackageDownloadInfo" - } - }, - "authorizedDevicesImportTemplate": { - "type": "array", - "description": "Authorized devices import template", - "readOnly": true, - "items": { - "$ref": "#/definitions/PackageDownloadInfo" - } - }, - "deviceInformationUpdateImportTemplate": { - "type": "array", - "description": "Authorized devices import template", - "readOnly": true, - "items": { - "$ref": "#/definitions/PackageDownloadInfo" - } - } - } - } - }, - "parameters": { - "IotDefenderSettingsModel": { - "name": "iotDefenderSettingsModel", - "in": "body", - "required": true, - "description": "The IoT defender settings model", - "schema": { - "$ref": "#/definitions/IotDefenderSettingsModel" - }, - "x-ms-parameter-location": "method" - } - } -} diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/iotRecommendationTypes.json b/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/iotRecommendationTypes.json deleted file mode 100644 index 9299fa3006e2..000000000000 --- a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/iotRecommendationTypes.json +++ /dev/null @@ -1,247 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "Security Center", - "description": "API spec for Microsoft.Security (Azure Security Center) resource provider", - "version": "2020-08-06-preview" - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ], - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Azure Active Directory OAuth2 Flow", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "paths": { - "/subscriptions/{subscriptionId}/providers/Microsoft.Security/iotRecommendationTypes": { - "get": { - "x-ms-examples": { - "Get IoT Recommendation Types": { - "$ref": "./examples/IotRecommendationTypes/GetIoTRecommendationTypeList.json" - } - }, - "tags": [ - "IoT Security Recommendation Types" - ], - "description": "List IoT recommendation types", - "operationId": "IotRecommendationTypes_List", - "parameters": [ - { - "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/IotRecommendationTypeList" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/definitions/CloudError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Security/iotRecommendationTypes/{iotRecommendationTypeName}": { - "get": { - "x-ms-examples": { - "Get IoT Recommendation Type": { - "$ref": "./examples/IotRecommendationTypes/GetIoTRecommendationType.json" - } - }, - "tags": [ - "IoT Security Recommendation Types" - ], - "operationId": "IotRecommendationTypes_Get", - "description": "Get IoT recommendation type", - "parameters": [ - { - "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" - }, - { - "in": "path", - "name": "iotRecommendationTypeName", - "required": true, - "type": "string", - "description": "Name of the recommendation type" - } - ], - "responses": { - "200": { - "description": "IoT recommendation type", - "schema": { - "$ref": "#/definitions/IotRecommendationType" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/definitions/CloudError" - } - } - } - } - } - }, - "definitions": { - "IotRecommendationTypeList": { - "type": "object", - "description": "List of recommendation types", - "properties": { - "value": { - "type": "array", - "description": "List data", - "items": { - "$ref": "#/definitions/IotRecommendationType" - } - } - } - }, - "IotRecommendationType": { - "type": "object", - "description": "IoT recommendation type.", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "description": "Recommendation type properties", - "$ref": "#/definitions/IotRecommendationTypeProperties" - } - }, - "allOf": [ - { - "$ref": "../../../common/v1/types.json#/definitions/Resource" - } - ] - }, - "IotRecommendationTypeProperties": { - "type": "object", - "description": "IoT recommendation type information.", - "properties": { - "recommendationDisplayName": { - "readOnly": true, - "type": "string", - "example": "TLS cipher suite upgrade needed", - "description": "The display name of the recommendation" - }, - "severity": { - "readOnly": true, - "type": "string", - "example": "Medium", - "description": "The severity of the recommendation", - "enum": [ - "Unknown", - "NotApplicable", - "Healthy", - "OffByPolicy", - "Low", - "Medium", - "High" - ], - "x-ms-enum": { - "name": "recommendationSeverity", - "modelAsString": true, - "values": [ - { - "value": "Unknown" - }, - { - "value": "NotApplicable" - }, - { - "value": "Healthy" - }, - { - "value": "OffByPolicy" - }, - { - "value": "Low" - }, - { - "value": "Medium" - }, - { - "value": "High" - } - ] - } - }, - "description": { - "readOnly": true, - "type": "string", - "description": "Description of the suspected vulnerability and meaning.", - "example": "Insecure TLS configurations detected. Immediate TLS cipher suite upgrade recommended." - }, - "productName": { - "readOnly": true, - "type": "string", - "example": "Azure Security Center for IoT", - "description": "The name of the product which published this recommendation" - }, - "productComponentName": { - "readOnly": true, - "type": "string", - "example": "IoT Hub", - "description": "The name of a component inside the product which generated the recommendation" - }, - "vendorName": { - "readOnly": true, - "type": "string", - "example": "Microsoft", - "description": "The name of the vendor that raised the recommendation" - }, - "control": { - "readOnly": true, - "type": "string", - "example": "Communication between device and IoT Hub is not optimized", - "description": "The name of the recommendation's control category " - }, - "remediationSteps": { - "readOnly": true, - "description": "Manual action items to take to resolve the recommendation", - "type": "array", - "items": { - "type": "string", - "example": "Upgrade your TLS cipher suite to a secure configuration. See the Guide to TLS Standards Compliance for more information." - } - }, - "dataSource": { - "readOnly": true, - "description": "The alert's data source", - "type": "string", - "example": "IoT Hub" - } - } - } - } -} diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/iotRecommendations.json b/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/iotRecommendations.json deleted file mode 100644 index 325bc059bf72..000000000000 --- a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/iotRecommendations.json +++ /dev/null @@ -1,233 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "Security Center", - "description": "API spec for Microsoft.Security (Azure Security Center) resource provider", - "version": "2020-08-06-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": { - "/{scope}/providers/Microsoft.Security/iotRecommendations": { - "get": { - "x-ms-examples": { - "Get IoT Recommendations": { - "$ref": "./examples/IotRecommendations/GetIoTRecommendationList.json" - } - }, - "tags": [ - "IoT Security Recommendations" - ], - "description": "List IoT recommendations", - "operationId": "IotRecommendations_List", - "parameters": [ - { - "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/IotRecommendationScope" - }, - { - "in": "query", - "name": "recommendationType", - "required": false, - "type": "string", - "description": "Filter by recommendation type" - }, - { - "in": "query", - "name": "deviceId", - "required": false, - "type": "string", - "description": "Filter by device id" - }, - { - "in": "query", - "name": "$limit", - "required": false, - "type": "integer", - "format": "int32", - "description": "Limit the number of items returned in a single page" - }, - { - "in": "query", - "name": "$skipToken", - "required": false, - "type": "string", - "description": "Skip token used for pagination" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/IotRecommendationListModel" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/definitions/CloudError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/{scope}/providers/Microsoft.Security/iotRecommendations/{iotRecommendationId}": { - "get": { - "x-ms-examples": { - "Get IoT Recommendation": { - "$ref": "./examples/IotRecommendations/GetIoTRecommendation.json" - } - }, - "tags": [ - "IoT Security Recommendations" - ], - "operationId": "IotRecommendations_Get", - "description": "Get IoT recommendation", - "parameters": [ - { - "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/IotRecommendationScope" - }, - { - "in": "path", - "name": "iotRecommendationId", - "required": true, - "type": "string", - "description": "Id of the recommendation" - } - ], - "responses": { - "200": { - "description": "IoT recommendation", - "schema": { - "$ref": "#/definitions/IotRecommendationModel" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/definitions/CloudError" - } - } - } - } - } - }, - "definitions": { - "IotRecommendationListModel": { - "description": "List of IoT recommendations", - "type": "object", - "properties": { - "value": { - "description": "List data", - "readOnly": true, - "type": "array", - "items": { - "$ref": "#/definitions/IotRecommendationModel" - } - }, - "nextLink": { - "readOnly": true, - "type": "string", - "description": "When available, follow the URI to get the next page of data" - } - } - }, - "IotRecommendationModel": { - "type": "object", - "description": "IoT recommendation", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "description": "Recommendation properties", - "$ref": "#/definitions/IotRecommendationPropertiesModel" - } - }, - "allOf": [ - { - "$ref": "../../../common/v1/types.json#/definitions/Resource" - } - ] - }, - "IotRecommendationPropertiesModel": { - "type": "object", - "description": "IoT recommendation properties", - "properties": { - "deviceId": { - "description": "Identifier of the device being reported on", - "readOnly": true, - "type": "string", - "example": "device-1" - }, - "recommendationType": { - "description": "The type name of the recommendation", - "readOnly": true, - "type": "string", - "example": "IoT_PrivilegedContainer" - }, - "discoveredTimeUtc": { - "description": "The discovery time of the recommendation", - "readOnly": true, - "type": "string", - "example": "2020-05-13T06:32:25Z" - }, - "recommendationAdditionalData": { - "type": "object", - "description": "A bag of fields which extends the recommendation information", - "example": { - "SnapshotId": "48519d58-4e35-46cd-aed5-6251af95ed50", - "TotalFailedRules": "7", - "TotalRulesFailedDuoToError": "1", - "TotalInformationalFailedRules": "2", - "TotalCriticalFailedRules": "3", - "TotalWarningFailedRules": "1" - } - } - } - } - }, - "parameters": { - "IotRecommendationScope": { - "name": "scope", - "in": "path", - "required": true, - "type": "string", - "description": "Scope of the query: Subscription (i.e. /subscriptions/{subscriptionId}) or IoT Hub (i.e. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Devices/iotHubs/{iotHubName})", - "x-ms-parameter-location": "method", - "x-ms-skip-url-encoding": true - } - } -} diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/iotSensors.json b/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/iotSensors.json deleted file mode 100644 index 84c5e3886d07..000000000000 --- a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/iotSensors.json +++ /dev/null @@ -1,528 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "Security Center", - "description": "API spec for Microsoft.Security (Azure Security Center) resource provider", - "version": "2020-08-06-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": { - "/{scope}/providers/Microsoft.Security/iotSensors": { - "get": { - "x-ms-examples": { - "List IoT sensors": { - "$ref": "./examples/IotSensors/List.json" - } - }, - "tags": [ - "IoT Sensors" - ], - "description": "List IoT sensors", - "operationId": "IotSensors_List", - "parameters": [ - { - "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/IotSensorScope" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/IotSensorsList" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/definitions/CloudError" - } - } - } - } - }, - "/{scope}/providers/Microsoft.Security/iotSensors/{iotSensorName}": { - "get": { - "x-ms-examples": { - "Get IoT sensor": { - "$ref": "./examples/IotSensors/Get.json" - } - }, - "tags": [ - "IoT Sensors" - ], - "operationId": "IotSensors_Get", - "description": "Get IoT sensor", - "parameters": [ - { - "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/IotSensorScope" - }, - { - "$ref": "#/parameters/IotSensorName" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/IotSensorsModel" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/definitions/CloudError" - } - } - } - }, - "put": { - "x-ms-examples": { - "Create or update IoT sensor": { - "$ref": "./examples/IotSensors/Put.json" - } - }, - "tags": [ - "IoT Sensors" - ], - "operationId": "IotSensors_CreateOrUpdate", - "description": "Create or update IoT sensor", - "parameters": [ - { - "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/IotSensorScope" - }, - { - "$ref": "#/parameters/IotSensorName" - }, - { - "$ref": "#/parameters/IotSensorsModel" - } - ], - "responses": { - "200": { - "description": "Updated IoT sensor", - "schema": { - "$ref": "#/definitions/IotSensorsModel" - } - }, - "201": { - "description": "Created IoT sensor", - "schema": { - "$ref": "#/definitions/IotSensorsModel" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/definitions/CloudError" - } - } - } - }, - "delete": { - "x-ms-examples": { - "Delete IoT sensor": { - "$ref": "./examples/IotSensors/Delete.json" - } - }, - "tags": [ - "IoT Sensors" - ], - "operationId": "IotSensors_Delete", - "description": "Delete IoT sensor", - "parameters": [ - { - "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/IotSensorScope" - }, - { - "$ref": "#/parameters/IotSensorName" - } - ], - "responses": { - "200": { - "description": "Deleted IoT sensor" - }, - "204": { - "description": "IoT sensor does not exist" - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/definitions/CloudError" - } - } - } - } - }, - "/{scope}/providers/Microsoft.Security/iotSensors/{iotSensorName}/downloadActivation": { - "post": { - "x-ms-examples": { - "Download activation file": { - "$ref": "./examples/IotSensors/DownloadActivation.json" - } - }, - "tags": [ - "IoT Sensors" - ], - "operationId": "IotSensors_DownloadActivation", - "description": "Download sensor activation file", - "produces": [ - "application/zip" - ], - "parameters": [ - { - "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/IotSensorScope" - }, - { - "$ref": "#/parameters/IotSensorName" - } - ], - "responses": { - "200": { - "description": "Downloaded activation file", - "schema": { - "type": "object", - "format": "file" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/definitions/CloudError" - } - } - } - } - }, - "/{scope}/providers/Microsoft.Security/iotSensors/{iotSensorName}/downloadResetPassword": { - "post": { - "x-ms-examples": { - "Download file for reset password of the sensor": { - "$ref": "./examples/IotSensors/DownloadResetPassword.json" - } - }, - "tags": [ - "IoT Sensors" - ], - "operationId": "IotSensors_DownloadResetPassword", - "description": "Download file for reset password of the sensor", - "produces": [ - "application/zip" - ], - "parameters": [ - { - "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/IotSensorScope" - }, - { - "$ref": "#/parameters/IotSensorName" - }, - { - "in": "body", - "name": "body", - "required": true, - "description": "The reset password input.", - "schema": { - "$ref": "#/definitions/ResetPasswordInput" - }, - "x-ms-parameter-location": "method" - } - ], - "responses": { - "200": { - "description": "Downloaded reset password file", - "schema": { - "type": "object", - "format": "file" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/definitions/CloudError" - } - } - } - } - }, - "/{scope}/providers/Microsoft.Security/iotSensors/{iotSensorName}/triggerTiPackageUpdate": { - "post": { - "x-ms-examples": { - "Trigger threat intelligence package update": { - "$ref": "./examples/IotSensors/TriggerTiPackageUpdate.json" - } - }, - "tags": [ - "IoT Sensors" - ], - "operationId": "IotSensors_TriggerTiPackageUpdate", - "description": "Trigger threat intelligence package update", - "parameters": [ - { - "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/IotSensorScope" - }, - { - "$ref": "#/parameters/IotSensorName" - } - ], - "responses": { - "200": { - "description": "Triggered threat intelligence package update" - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/definitions/CloudError" - } - } - } - } - } - }, - "definitions": { - "IotSensorsList": { - "description": "List of IoT sensors", - "type": "object", - "properties": { - "value": { - "description": "List data", - "readOnly": true, - "type": "array", - "items": { - "$ref": "#/definitions/IotSensorsModel" - } - } - } - }, - "IotSensorsModel": { - "type": "object", - "description": "IoT sensor model", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "description": "IoT sensor properties", - "$ref": "#/definitions/IotSensorProperties" - } - }, - "allOf": [ - { - "$ref": "../../../common/v1/types.json#/definitions/Resource" - } - ] - }, - "IotSensorProperties": { - "type": "object", - "description": "IoT sensor properties", - "properties": { - "connectivityTime": { - "description": "Last connectivity time of the IoT sensor", - "readOnly": true, - "type": "string", - "example": "2020-11-17T12:31:25Z" - }, - "creationTime": { - "description": "Creation time of the IoT sensor", - "readOnly": true, - "type": "string", - "example": "2020-11-17T12:31:25Z" - }, - "dynamicLearning": { - "description": "Dynamic mode status of the IoT sensor", - "example": true, - "readOnly": true, - "type": "boolean" - }, - "learningMode": { - "description": "Learning mode status of the IoT sensor", - "example": true, - "readOnly": true, - "type": "boolean" - }, - "sensorStatus": { - "readOnly": true, - "type": "string", - "example": "Ok", - "description": "Status of the IoT sensor", - "enum": [ - "Ok", - "Disconnected", - "Unavailable" - ], - "x-ms-enum": { - "name": "sensorStatus", - "modelAsString": true, - "values": [ - { - "value": "Ok" - }, - { - "value": "Disconnected" - }, - { - "value": "Unavailable" - } - ] - } - }, - "sensorVersion": { - "description": "Version of the IoT sensor", - "readOnly": true, - "type": "string", - "example": "2020.11.01.1643" - }, - "tiAutomaticUpdates": { - "description": "TI Automatic mode status of the IoT sensor", - "example": true, - "type": "boolean" - }, - "tiStatus": { - "readOnly": true, - "type": "string", - "example": "Ok", - "description": "TI Status of the IoT sensor", - "enum": [ - "Ok", - "Failed", - "InProgress", - "UpdateAvailable" - ], - "x-ms-enum": { - "name": "tiStatus", - "modelAsString": true, - "values": [ - { - "value": "Ok" - }, - { - "value": "Failed" - }, - { - "value": "InProgress" - }, - { - "value": "UpdateAvailable" - } - ] - } - }, - "tiVersion": { - "description": "TI Version of the IoT sensor", - "readOnly": true, - "type": "string", - "example": "2020-11-17T12:31:25Z" - }, - "zone": { - "type": "string", - "description": "Zone of the IoT sensor", - "example": "A12" - }, - "sensorType": { - "description": "Type of sensor", - "example": "Ot", - "type": "string", - "enum": [ - "Ot", - "Enterprise" - ], - "x-ms-enum": { - "name": "sensorType", - "modelAsString": true, - "values": [ - { - "value": "Ot" - }, - { - "value": "Enterprise" - } - ] - } - } - } - }, - "ResetPasswordInput": { - "type": "object", - "description": "Reset password input.", - "properties": { - "applianceId": { - "description": "The appliance id of the sensor.", - "type": "string" - } - } - } - }, - "parameters": { - "IotSensorScope": { - "name": "scope", - "in": "path", - "required": true, - "type": "string", - "description": "Scope of the query (IoT Hub, /providers/Microsoft.Devices/iotHubs/myHub)", - "x-ms-parameter-location": "method", - "x-ms-skip-url-encoding": true - }, - "IotSensorName": { - "name": "iotSensorName", - "in": "path", - "required": true, - "type": "string", - "description": "Name of the IoT sensor", - "x-ms-parameter-location": "method" - }, - "IotSensorsModel": { - "name": "iotSensorsModel", - "in": "body", - "required": true, - "description": "The IoT sensor model", - "schema": { - "$ref": "#/definitions/IotSensorsModel" - }, - "x-ms-parameter-location": "method" - } - } -} diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/iotSites.json b/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/iotSites.json deleted file mode 100644 index 085ac8e072fb..000000000000 --- a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/iotSites.json +++ /dev/null @@ -1,260 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "Security Center", - "description": "API spec for Microsoft.Security (Azure Security Center) resource provider", - "version": "2020-08-06-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": { - "/{scope}/providers/Microsoft.Security/iotSites": { - "get": { - "x-ms-examples": { - "List IoT sites": { - "$ref": "./examples/IotSites/List.json" - } - }, - "tags": [ - "IoT Sites" - ], - "description": "List IoT sites", - "operationId": "IotSites_List", - "parameters": [ - { - "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/IotSiteScope" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/IotSitesList" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/definitions/CloudError" - } - } - } - } - }, - "/{scope}/providers/Microsoft.Security/iotSites/default": { - "get": { - "x-ms-examples": { - "Get IoT site": { - "$ref": "./examples/IotSites/Get.json" - } - }, - "tags": [ - "IoT Sites" - ], - "operationId": "IotSites_Get", - "description": "Get IoT site", - "parameters": [ - { - "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/IotSiteScope" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/IotSitesModel" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/definitions/CloudError" - } - } - } - }, - "put": { - "x-ms-examples": { - "Create or update IoT site": { - "$ref": "./examples/IotSites/Put.json" - } - }, - "tags": [ - "IoT Sites" - ], - "operationId": "IotSites_CreateOrUpdate", - "description": "Create or update IoT site", - "parameters": [ - { - "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/IotSiteScope" - }, - { - "$ref": "#/parameters/IotSitesModel" - } - ], - "responses": { - "200": { - "description": "Updated IoT site", - "schema": { - "$ref": "#/definitions/IotSitesModel" - } - }, - "201": { - "description": "Created IoT site", - "schema": { - "$ref": "#/definitions/IotSitesModel" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/definitions/CloudError" - } - } - } - }, - "delete": { - "x-ms-examples": { - "Delete IoT site": { - "$ref": "./examples/IotSites/Delete.json" - } - }, - "tags": [ - "IoT Sites" - ], - "operationId": "IotSites_Delete", - "description": "Delete IoT site", - "parameters": [ - { - "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/IotSiteScope" - } - ], - "responses": { - "200": { - "description": "Deleted IoT site" - }, - "204": { - "description": "IoT site does not exist" - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/definitions/CloudError" - } - } - } - } - } - }, - "definitions": { - "IotSitesList": { - "description": "List of IoT sites", - "type": "object", - "properties": { - "value": { - "description": "List data", - "readOnly": true, - "type": "array", - "items": { - "$ref": "#/definitions/IotSitesModel" - } - } - } - }, - "IotSitesModel": { - "type": "object", - "description": "IoT site model", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "description": "IoT site properties", - "$ref": "#/definitions/IotSiteProperties" - } - }, - "allOf": [ - { - "$ref": "../../../common/v1/types.json#/definitions/Resource" - } - ] - }, - "IotSiteProperties": { - "type": "object", - "description": "IoT site properties", - "properties": { - "displayName": { - "type": "string", - "description": "Display name of the IoT site" - }, - "tags": { - "type": "object", - "description": "Tags of the IoT site", - "additionalProperties": { - "type": "string" - } - } - }, - "required": [ - "displayName" - ] - } - }, - "parameters": { - "IotSiteScope": { - "name": "scope", - "in": "path", - "required": true, - "type": "string", - "description": "Scope of the query (IoT Hub, /providers/Microsoft.Devices/iotHubs/myHub)", - "x-ms-parameter-location": "method", - "x-ms-skip-url-encoding": true - }, - "IotSitesModel": { - "name": "iotSitesModel", - "in": "body", - "required": true, - "description": "The IoT sites model", - "schema": { - "$ref": "#/definitions/IotSitesModel" - }, - "x-ms-parameter-location": "method" - } - } -} diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/onPremiseIotSensors.json b/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/onPremiseIotSensors.json deleted file mode 100644 index 97492fd35bed..000000000000 --- a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/onPremiseIotSensors.json +++ /dev/null @@ -1,346 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "Security Center", - "description": "API spec for Microsoft.Security (Azure Security Center) resource provider", - "version": "2020-08-06-preview" - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ], - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Azure Active Directory OAuth2 Flow", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "paths": { - "/subscriptions/{subscriptionId}/providers/Microsoft.Security/onPremiseIotSensors": { - "get": { - "x-ms-examples": { - "List on-premise IoT sensors": { - "$ref": "./examples/OnPremiseIotSensors/List.json" - } - }, - "tags": [ - "On-Premise IoT Sensors" - ], - "description": "List on-premise IoT sensors", - "operationId": "OnPremiseIotSensors_List", - "parameters": [ - { - "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/OnPremiseIotSensorsList" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/definitions/CloudError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Security/onPremiseIotSensors/{onPremiseIotSensorName}": { - "get": { - "x-ms-examples": { - "Get on-premise IoT sensor": { - "$ref": "./examples/OnPremiseIotSensors/Get.json" - } - }, - "tags": [ - "On-Premise IoT Sensors" - ], - "operationId": "OnPremiseIotSensors_Get", - "description": "Get on-premise IoT sensor", - "parameters": [ - { - "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" - }, - { - "$ref": "#/parameters/OnPremiseIotSensorName" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/OnPremiseIotSensor" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/definitions/CloudError" - } - } - } - }, - "put": { - "x-ms-examples": { - "Create or update on-premise IoT sensor": { - "$ref": "./examples/OnPremiseIotSensors/Put.json" - } - }, - "tags": [ - "On-Premise IoT Sensors" - ], - "operationId": "OnPremiseIotSensors_CreateOrUpdate", - "description": "Create or update on-premise IoT sensor", - "parameters": [ - { - "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" - }, - { - "$ref": "#/parameters/OnPremiseIotSensorName" - } - ], - "responses": { - "200": { - "description": "Updated on-premise IoT sensor", - "schema": { - "$ref": "#/definitions/OnPremiseIotSensor" - } - }, - "201": { - "description": "Created on-premise IoT sensor", - "schema": { - "$ref": "#/definitions/OnPremiseIotSensor" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/definitions/CloudError" - } - } - } - }, - "delete": { - "x-ms-examples": { - "Delete on-premise IoT sensor": { - "$ref": "./examples/OnPremiseIotSensors/Delete.json" - } - }, - "tags": [ - "On-Premise IoT Sensors" - ], - "operationId": "OnPremiseIotSensors_Delete", - "description": "Delete on-premise IoT sensor", - "parameters": [ - { - "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" - }, - { - "$ref": "#/parameters/OnPremiseIotSensorName" - } - ], - "responses": { - "200": { - "description": "Deleted on-premise IoT sensor" - }, - "204": { - "description": "On-premise IoT sensor does not exist" - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/definitions/CloudError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Security/onPremiseIotSensors/{onPremiseIotSensorName}/downloadActivation": { - "post": { - "x-ms-examples": { - "Download activation file": { - "$ref": "./examples/OnPremiseIotSensors/DownloadActivation.json" - } - }, - "tags": [ - "On-Premise IoT Sensors" - ], - "operationId": "OnPremiseIotSensors_DownloadActivation", - "description": "Download sensor activation file", - "produces": [ - "application/zip" - ], - "parameters": [ - { - "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" - }, - { - "$ref": "#/parameters/OnPremiseIotSensorName" - } - ], - "responses": { - "200": { - "description": "Downloaded activation file", - "schema": { - "type": "object", - "format": "file" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/definitions/CloudError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Security/onPremiseIotSensors/{onPremiseIotSensorName}/downloadResetPassword": { - "post": { - "x-ms-examples": { - "Download file for reset password of the sensor": { - "$ref": "./examples/OnPremiseIotSensors/DownloadResetPassword.json" - } - }, - "tags": [ - "IoT Sensors" - ], - "operationId": "OnPremiseIotSensors_DownloadResetPassword", - "description": "Download file for reset password of the sensor", - "produces": [ - "application/zip" - ], - "parameters": [ - { - "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" - }, - { - "$ref": "#/parameters/OnPremiseIotSensorName" - }, - { - "in": "body", - "name": "body", - "required": true, - "description": "Input for reset password.", - "schema": { - "$ref": "#/definitions/ResetPasswordInput" - }, - "x-ms-parameter-location": "method" - } - ], - "responses": { - "200": { - "description": "Downloaded reset password file", - "schema": { - "type": "object", - "format": "file" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/definitions/CloudError" - } - } - } - } - } - }, - "definitions": { - "OnPremiseIotSensorsList": { - "description": "List of on-premise IoT sensors", - "type": "object", - "properties": { - "value": { - "description": "List data", - "readOnly": true, - "type": "array", - "items": { - "$ref": "#/definitions/OnPremiseIotSensor" - } - } - } - }, - "OnPremiseIotSensor": { - "type": "object", - "description": "On-premise IoT sensor", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "description": "On-premise IoT sensor properties", - "$ref": "#/definitions/OnPremiseIotSensorProperties" - } - }, - "allOf": [ - { - "$ref": "../../../common/v1/types.json#/definitions/Resource" - } - ] - }, - "OnPremiseIotSensorProperties": { - "type": "object", - "description": "On-premise IoT sensor properties", - "properties": {} - }, - "ResetPasswordInput": { - "description": "Reset password input.", - "type": "object", - "properties": { - "applianceId": { - "description": "The appliance id of the sensor.", - "type": "string" - } - } - } - }, - "parameters": { - "OnPremiseIotSensorName": { - "name": "onPremiseIotSensorName", - "in": "path", - "required": true, - "type": "string", - "description": "Name of the on-premise IoT sensor", - "x-ms-parameter-location": "method" - } - } -} diff --git a/specification/security/resource-manager/readme.md b/specification/security/resource-manager/readme.md index ba906731c15b..d4b674a1eb50 100644 --- a/specification/security/resource-manager/readme.md +++ b/specification/security/resource-manager/readme.md @@ -36,30 +36,6 @@ directive: from: iotSecuritySolutionAnalytics.json where: '$.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/iotSecuritySolutions/{solutionName}/analyticsModels"].get' reason: The list returns limited number of items - - suppress: PageableOperation - from: alertTypes.json - where: '$.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/iotSecuritySolutions/{solutionName}/alertTypes"].get' - reason: The list returns limited number of items - - suppress: PageableOperation - from: recommendationTypes.json - where: '$.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/iotSecuritySolutions/{solutionName}/recommendationTypes"].get' - reason: The list returns limited number of items - - suppress: PageableOperation - from: iotDefenderSettings.json - where: '$.paths["/subscriptions/{subscriptionId}/providers/Microsoft.Security/iotDefenderSettings"].get' - reason: The list returns limited number of items - - suppress: PageableOperation - from: iotSensors.json - where: '$.paths["/{scope}/providers/Microsoft.Security/iotSensors/{iotSensorName}"].get' - reason: The list returns limited number of items - - suppress: PageableOperation - from: onPremiseIotSensors.json - where: '$.paths["/subscriptions/{subscriptionId}/providers/Microsoft.Security/onPremiseIotSensors"].get' - reason: The list returns limited number of items - - suppress: TopLevelResourcesListByResourceGroup - from: onPremiseIotSensors.json - where: $.definitions.OnPremiseIotSensor - reason: The resource is managed in a subscription level (instead of inside a resource group) - suppress: SECRET_PROPERTY from: ingestionSettings.json where: $.definitions.IngestionSettingToken.properties.token @@ -215,15 +191,6 @@ input-file: - Microsoft.Security/preview/2020-07-01-preview/sqlVulnerabilityAssessmentsScanOperations.json - Microsoft.Security/preview/2020-07-01-preview/sqlVulnerabilityAssessmentsScanResultsOperations.json - Microsoft.Security/preview/2020-07-01-preview/sqlVulnerabilityAssessmentsBaselineRuleOperations.json -- Microsoft.Security/preview/2020-08-06-preview/iotDefenderSettings.json -- Microsoft.Security/preview/2020-08-06-preview/iotSensors.json -- Microsoft.Security/preview/2020-08-06-preview/devices.json -- Microsoft.Security/preview/2020-08-06-preview/onPremiseIotSensors.json -- Microsoft.Security/preview/2020-08-06-preview/iotSites.json -- Microsoft.Security/preview/2020-08-06-preview/iotAlerts.json -- Microsoft.Security/preview/2020-08-06-preview/iotAlertTypes.json -- Microsoft.Security/preview/2020-08-06-preview/iotRecommendations.json -- Microsoft.Security/preview/2020-08-06-preview/iotRecommendationTypes.json - Microsoft.Security/stable/2021-01-01/alerts.json - Microsoft.Security/stable/2021-07-01/settings.json - Microsoft.Security/preview/2021-01-15-preview/ingestionSettings.json @@ -422,27 +389,6 @@ override-info: title: SecurityCenter ``` -### Tag: package-2020-08-preview-only - -These settings apply only when `--tag=package-2020-08-preview-only` is specified on the command line. This tag is used for Ruby SDK. - -``` yaml $(tag) == 'package-2020-08-preview-only' -input-file: -- Microsoft.Security/preview/2020-08-06-preview/iotDefenderSettings.json -- Microsoft.Security/preview/2020-08-06-preview/iotSensors.json -- Microsoft.Security/preview/2020-08-06-preview/devices.json -- Microsoft.Security/preview/2020-08-06-preview/onPremiseIotSensors.json -- Microsoft.Security/preview/2020-08-06-preview/iotSites.json -- Microsoft.Security/preview/2020-08-06-preview/iotAlerts.json -- Microsoft.Security/preview/2020-08-06-preview/iotAlertTypes.json -- Microsoft.Security/preview/2020-08-06-preview/iotRecommendations.json -- Microsoft.Security/preview/2020-08-06-preview/iotRecommendationTypes.json - -# Needed when there is more than one input file -override-info: - title: SecurityCenter -``` - ### Tag: package-2021-01-preview-only These settings apply only when `--tag=package-2021-01-preview-only` is specified on the command line. This tag is used for Ruby SDK. diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/Bookmarks.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/Bookmarks.json index beed814dd448..dbb332f13015 100644 --- a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/Bookmarks.json +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/Bookmarks.json @@ -617,6 +617,7 @@ "type": "array" } }, + "type": "object", "required": [ "value" ] diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/Cases.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/Cases.json index 9fc37ddb3210..d95a503de738 100644 --- a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/Cases.json +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/Cases.json @@ -1019,6 +1019,7 @@ } } }, + "type": "object", "required": [ "value" ] diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/DataConnectorsCheckRequirements.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/DataConnectorsCheckRequirements.json new file mode 100644 index 000000000000..1dbff9e13a48 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/DataConnectorsCheckRequirements.json @@ -0,0 +1,503 @@ +{ + "swagger": "2.0", + "info": { + "title": "Security Insights", + "description": "API spec for Microsoft.SecurityInsights (Azure Security Insights) resource provider", + "version": "2019-01-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/dataConnectorsCheckRequirements": { + "post": { + "x-ms-examples": { + "Check requirements for TI.": { + "$ref": "./examples/dataConnectors/CheckRequirementsThreatIntelligence.json" + }, + "Check requirements for TI Taxii.": { + "$ref": "./examples/dataConnectors/CheckRequirementsThreatIntelligenceTaxii.json" + }, + "Check requirements for AAD.": { + "$ref": "./examples/dataConnectors/CheckRequirementsAzureActiveDirectory.json" + }, + "Check requirements for AAD - no license.": { + "$ref": "./examples/dataConnectors/CheckRequirementsAzureActiveDirectoryNoLicense.json" + }, + "Check requirements for AAD - no authorization.": { + "$ref": "./examples/dataConnectors/CheckRequirementsAzureActiveDirectoryNoAuthorization.json" + }, + "Check requirements for ASC.": { + "$ref": "./examples/dataConnectors/CheckRequirementsAzureSecurityCenter.json" + }, + "Check requirements for Mcas.": { + "$ref": "./examples/dataConnectors/CheckRequirementsMicrosoftCloudAppSecurity.json" + }, + "Check requirements for Mdatp.": { + "$ref": "./examples/dataConnectors/CheckRequirementsMdatp.json" + }, + "Check requirements for OfficeATP.": { + "$ref": "./examples/dataConnectors/CheckRequirementsOfficeATP.json" + }, + "Check requirements for Dynamics365.": { + "$ref": "./examples/dataConnectors/CheckRequirementsDynamics365.json" + }, + "Check requirements for MicrosoftThreatProtection.": { + "$ref": "./examples/dataConnectors/CheckRequirementsMicrosoftThreatProtection.json" + }, + "Check requirements for MicrosoftThreatIntelligence.": { + "$ref": "./examples/dataConnectors/CheckRequirementsMicrosoftThreatIntelligence.json" + } + }, + "tags": [ + "Check Data Connector Requirements" + ], + "description": "Get requirements state for a data connector type.", + "operationId": "DataConnectorsCheckRequirements_Post", + "parameters": [ + { + "$ref": "SecurityInsights.json#/parameters/ApiVersion" + }, + { + "$ref": "SecurityInsights.json#/parameters/SubscriptionId" + }, + { + "$ref": "SecurityInsights.json#/parameters/ResourceGroupName" + }, + { + "$ref": "SecurityInsights.json#/parameters/WorkspaceName" + }, + { + "$ref": "SecurityInsights.json#/parameters/OperationalInsightsResourceProvider" + }, + { + "$ref": "#/parameters/DataConnectorsCheckRequirementsBody" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DataConnectorRequirementsState" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "SecurityInsights.json#/definitions/CloudError" + } + } + } + } + } + }, + "parameters": { + "DataConnectorsCheckRequirementsBody": { + "description": "The parameters for requirements check message", + "in": "body", + "name": "DataConnectorsCheckRequirements", + "required": true, + "schema": { + "$ref": "#/definitions/DataConnectorsCheckRequirements" + }, + "x-ms-parameter-location": "method" + } + }, + "definitions": { + "AADCheckRequirements": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorsCheckRequirements" + } + ], + "description": "Represents AAD (Azure Active Directory) requirements check request.", + "properties": { + "properties": { + "$ref": "#/definitions/AADCheckRequirementsProperties", + "description": "AAD (Azure Active Directory) requirements check properties.", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "AzureActiveDirectory" + }, + "AADCheckRequirementsProperties": { + "allOf": [ + { + "$ref": "SecurityInsights.json#/definitions/DataConnectorTenantId" + } + ], + "description": "AAD (Azure Active Directory) requirements check properties.", + "type": "object" + }, + "AATPCheckRequirements": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorsCheckRequirements" + } + ], + "description": "Represents AATP (Azure Advanced Threat Protection) requirements check request.", + "properties": { + "properties": { + "$ref": "#/definitions/AATPCheckRequirementsProperties", + "description": "AATP (Azure Advanced Threat Protection) requirements check properties.", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "AzureAdvancedThreatProtection" + }, + "AATPCheckRequirementsProperties": { + "allOf": [ + { + "$ref": "SecurityInsights.json#/definitions/DataConnectorTenantId" + } + ], + "description": "AATP (Azure Advanced Threat Protection) requirements check properties.", + "type": "object" + }, + "ASCCheckRequirements": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorsCheckRequirements" + } + ], + "description": "Represents ASC (Azure Security Center) requirements check request.", + "properties": { + "properties": { + "$ref": "#/definitions/ASCCheckRequirementsProperties", + "description": "ASC (Azure Security Center) requirements check properties.", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "AzureSecurityCenter" + }, + "ASCCheckRequirementsProperties": { + "description": "ASC (Azure Security Center) requirements check properties.", + "properties": { + "subscriptionId": { + "description": "The subscription id to connect to, and get the data from.", + "type": "string" + } + }, + "type": "object" + }, + "AwsCloudTrailCheckRequirements": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorsCheckRequirements" + } + ], + "description": "Amazon Web Services CloudTrail requirements check request.", + "type": "object", + "x-ms-discriminator-value": "AmazonWebServicesCloudTrail" + }, + "DataConnectorsCheckRequirements": { + "description": "Data connector requirements properties.", + "properties": { + "kind": { + "$ref": "SecurityInsights.json#/definitions/DataConnectorKind", + "description": "Describes the kind of connector to be checked." + } + }, + "discriminator": "kind", + "type": "object", + "required": [ + "kind" + ] + }, + "DataConnectorAuthorizationState": { + "description": "Describes the state of user's authorization for a connector kind.", + "enum": [ + "Valid", + "Invalid" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "DataConnectorAuthorizationState", + "values": [ + { + "value": "Valid" + }, + { + "value": "Invalid" + } + ] + } + }, + "DataConnectorLicenseState": { + "description": "Describes the state of user's license for a connector kind.", + "enum": [ + "Valid", + "Invalid", + "Unknown" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "DataConnectorLicenseState", + "values": [ + { + "value": "Valid" + }, + { + "value": "Invalid" + }, + { + "value": "Unknown" + } + ] + } + }, + "DataConnectorRequirementsState": { + "description": "Data connector requirements status.", + "properties": { + "authorizationState": { + "description": "Authorization state for this connector", + "$ref": "#/definitions/DataConnectorAuthorizationState" + }, + "licenseState": { + "description": "License state for this connector", + "$ref": "#/definitions/DataConnectorLicenseState" + } + }, + "type": "object" + }, + "Dynamics365CheckRequirements": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorsCheckRequirements" + } + ], + "description": "Represents Dynamics365 requirements check request.", + "properties": { + "properties": { + "$ref": "#/definitions/Dynamics365CheckRequirementsProperties", + "description": "Dynamics365 requirements check properties.", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "Dynamics365" + }, + "Dynamics365CheckRequirementsProperties": { + "allOf": [ + { + "$ref": "SecurityInsights.json#/definitions/DataConnectorTenantId" + } + ], + "description": "Dynamics365 requirements check properties.", + "type": "object" + }, + "MCASCheckRequirements": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorsCheckRequirements" + } + ], + "description": "Represents MCAS (Microsoft Cloud App Security) requirements check request.", + "properties": { + "properties": { + "$ref": "#/definitions/MCASCheckRequirementsProperties", + "description": "MCAS (Microsoft Cloud App Security) requirements check properties.", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "MicrosoftCloudAppSecurity" + }, + "MCASCheckRequirementsProperties": { + "allOf": [ + { + "$ref": "SecurityInsights.json#/definitions/DataConnectorTenantId" + } + ], + "description": "MCAS (Microsoft Cloud App Security) requirements check properties.", + "type": "object" + }, + "MDATPCheckRequirements": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorsCheckRequirements" + } + ], + "description": "Represents MDATP (Microsoft Defender Advanced Threat Protection) requirements check request.", + "properties": { + "properties": { + "$ref": "#/definitions/MDATPCheckRequirementsProperties", + "description": "MDATP (Microsoft Defender Advanced Threat Protection) requirements check properties.", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "MicrosoftDefenderAdvancedThreatProtection" + }, + "MDATPCheckRequirementsProperties": { + "allOf": [ + { + "$ref": "SecurityInsights.json#/definitions/DataConnectorTenantId" + } + ], + "description": "MDATP (Microsoft Defender Advanced Threat Protection) requirements check properties.", + "type": "object" + }, + "MSTICheckRequirements": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorsCheckRequirements" + } + ], + "description": "Represents Microsoft Threat Intelligence requirements check request.", + "properties": { + "properties": { + "$ref": "#/definitions/MSTICheckRequirementsProperties", + "description": "Microsoft Threat Intelligence requirements check properties.", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "MicrosoftThreatIntelligence" + }, + "MSTICheckRequirementsProperties": { + "allOf": [ + { + "$ref": "SecurityInsights.json#/definitions/DataConnectorTenantId" + } + ], + "description": "Microsoft Threat Intelligence requirements check properties.", + "type": "object" + }, + "MtpCheckRequirements": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorsCheckRequirements" + } + ], + "description": "Represents MTP (Microsoft Threat Protection) requirements check request.", + "properties": { + "properties": { + "$ref": "#/definitions/MTPCheckRequirementsProperties", + "description": "MTP (Microsoft Threat Protection) requirements check properties.", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "MicrosoftThreatProtection" + }, + "MTPCheckRequirementsProperties": { + "allOf": [ + { + "$ref": "SecurityInsights.json#/definitions/DataConnectorTenantId" + } + ], + "description": "MTP (Microsoft Threat Protection) requirements check properties.", + "type": "object" + }, + "OfficeATPCheckRequirements": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorsCheckRequirements" + } + ], + "description": "Represents OfficeATP (Office 365 Advanced Threat Protection) requirements check request.", + "properties": { + "properties": { + "$ref": "#/definitions/OfficeATPCheckRequirementsProperties", + "description": "OfficeATP (Office 365 Advanced Threat Protection) requirements check properties.", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "OfficeATP" + }, + "OfficeATPCheckRequirementsProperties": { + "allOf": [ + { + "$ref": "SecurityInsights.json#/definitions/DataConnectorTenantId" + } + ], + "description": "OfficeATP (Office 365 Advanced Threat Protection) requirements check properties.", + "type": "object" + }, + "TICheckRequirements": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorsCheckRequirements" + } + ], + "description": "Threat Intelligence Platforms data connector check requirements", + "properties": { + "properties": { + "$ref": "#/definitions/TICheckRequirementsProperties", + "description": "Threat Intelligence Platforms data connector check required properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "ThreatIntelligence" + }, + "TICheckRequirementsProperties": { + "allOf": [ + { + "$ref": "SecurityInsights.json#/definitions/DataConnectorTenantId" + } + ], + "description": "Threat Intelligence Platforms data connector required properties.", + "properties": {}, + "type": "object" + }, + "TiTaxiiCheckRequirements": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorsCheckRequirements" + } + ], + "description": "Threat Intelligence TAXII data connector check requirements", + "properties": { + "properties": { + "$ref": "#/definitions/TiTaxiiCheckRequirementsProperties", + "description": "Threat Intelligence TAXII check required properties.", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "ThreatIntelligenceTaxii" + }, + "TiTaxiiCheckRequirementsProperties": { + "allOf": [ + { + "$ref": "SecurityInsights.json#/definitions/DataConnectorTenantId" + } + ], + "description": "Threat Intelligence TAXII data connector required properties.", + "type": "object" + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/OfficeConsents.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/OfficeConsents.json index 6b215cd58827..7de815337dc8 100644 --- a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/OfficeConsents.json +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/OfficeConsents.json @@ -220,6 +220,7 @@ "type": "array" } }, + "type": "object", "required": [ "value" ] diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/SecurityInsights.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/SecurityInsights.json index c9908a3484a5..0577a3b91208 100644 --- a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/SecurityInsights.json +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/SecurityInsights.json @@ -815,87 +815,6 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/dataConnectorsCheckRequirements": { - "post": { - "x-ms-examples": { - "Check requirements for TI.": { - "$ref": "./examples/dataConnectors/CheckRequirementsThreatIntelligence.json" - }, - "Check requirements for TI Taxii.": { - "$ref": "./examples/dataConnectors/CheckRequirementsThreatIntelligenceTaxii.json" - }, - "Check requirements for AAD.": { - "$ref": "./examples/dataConnectors/CheckRequirementsAzureActiveDirectory.json" - }, - "Check requirements for AAD - no license.": { - "$ref": "./examples/dataConnectors/CheckRequirementsAzureActiveDirectoryNoLicense.json" - }, - "Check requirements for AAD - no authorization.": { - "$ref": "./examples/dataConnectors/CheckRequirementsAzureActiveDirectoryNoAuthorization.json" - }, - "Check requirements for ASC.": { - "$ref": "./examples/dataConnectors/CheckRequirementsAzureSecurityCenter.json" - }, - "Check requirements for Mcas.": { - "$ref": "./examples/dataConnectors/CheckRequirementsMicrosoftCloudAppSecurity.json" - }, - "Check requirements for Mdatp.": { - "$ref": "./examples/dataConnectors/CheckRequirementsMdatp.json" - }, - "Check requirements for OfficeATP.": { - "$ref": "./examples/dataConnectors/CheckRequirementsOfficeATP.json" - }, - "Check requirements for Dynamics365.": { - "$ref": "./examples/dataConnectors/CheckRequirementsDynamics365.json" - }, - "Check requirements for MicrosoftThreatProtection.": { - "$ref": "./examples/dataConnectors/CheckRequirementsMicrosoftThreatProtection.json" - }, - "Check requirements for MicrosoftThreatIntelligence.": { - "$ref": "./examples/dataConnectors/CheckRequirementsMicrosoftThreatIntelligence.json" - } - }, - "tags": [ - "Check Data Connector Requirements" - ], - "description": "Get requirements state for a data connector type.", - "operationId": "DataConnectorsCheckRequirements_Post", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/SubscriptionId" - }, - { - "$ref": "#/parameters/ResourceGroupName" - }, - { - "$ref": "#/parameters/WorkspaceName" - }, - { - "$ref": "#/parameters/OperationalInsightsResourceProvider" - }, - { - "$ref": "#/parameters/DataConnectorsCheckRequirementsBody" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/DataConnectorRequirementsState" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - } - }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/settings": { "get": { "x-ms-examples": { @@ -2555,32 +2474,6 @@ "description": "AAD (Azure Active Directory) data connector properties.", "type": "object" }, - "AADCheckRequirements": { - "allOf": [ - { - "$ref": "#/definitions/DataConnectorsCheckRequirements" - } - ], - "description": "Represents AAD (Azure Active Directory) requirements check request.", - "properties": { - "properties": { - "$ref": "#/definitions/AADCheckRequirementsProperties", - "description": "AAD (Azure Active Directory) requirements check properties.", - "x-ms-client-flatten": true - } - }, - "type": "object", - "x-ms-discriminator-value": "AzureActiveDirectory" - }, - "AADCheckRequirementsProperties": { - "allOf": [ - { - "$ref": "#/definitions/DataConnectorTenantId" - } - ], - "description": "AAD (Azure Active Directory) requirements check properties.", - "type": "object" - }, "AATPDataConnector": { "allOf": [ { @@ -2610,32 +2503,6 @@ "description": "AATP (Azure Advanced Threat Protection) data connector properties.", "type": "object" }, - "AATPCheckRequirements": { - "allOf": [ - { - "$ref": "#/definitions/DataConnectorsCheckRequirements" - } - ], - "description": "Represents AATP (Azure Advanced Threat Protection) requirements check request.", - "properties": { - "properties": { - "$ref": "#/definitions/AATPCheckRequirementsProperties", - "description": "AATP (Azure Advanced Threat Protection) requirements check properties.", - "x-ms-client-flatten": true - } - }, - "type": "object", - "x-ms-discriminator-value": "AzureAdvancedThreatProtection" - }, - "AATPCheckRequirementsProperties": { - "allOf": [ - { - "$ref": "#/definitions/DataConnectorTenantId" - } - ], - "description": "AATP (Azure Advanced Threat Protection) requirements check properties.", - "type": "object" - }, "MSTIDataConnector": { "allOf": [ { @@ -2717,32 +2584,6 @@ ], "type": "object" }, - "MSTICheckRequirements": { - "allOf": [ - { - "$ref": "#/definitions/DataConnectorsCheckRequirements" - } - ], - "description": "Represents Microsoft Threat Intelligence requirements check request.", - "properties": { - "properties": { - "$ref": "#/definitions/MSTICheckRequirementsProperties", - "description": "Microsoft Threat Intelligence requirements check properties.", - "x-ms-client-flatten": true - } - }, - "type": "object", - "x-ms-discriminator-value": "MicrosoftThreatIntelligence" - }, - "MSTICheckRequirementsProperties": { - "allOf": [ - { - "$ref": "#/definitions/DataConnectorTenantId" - } - ], - "description": "Microsoft Threat Intelligence requirements check properties.", - "type": "object" - }, "MTPDataConnector": { "allOf": [ { @@ -2796,32 +2637,6 @@ ], "type": "object" }, - "MtpCheckRequirements": { - "allOf": [ - { - "$ref": "#/definitions/DataConnectorsCheckRequirements" - } - ], - "description": "Represents MTP (Microsoft Threat Protection) requirements check request.", - "properties": { - "properties": { - "$ref": "#/definitions/MTPCheckRequirementsProperties", - "description": "MTP (Microsoft Threat Protection) requirements check properties.", - "x-ms-client-flatten": true - } - }, - "type": "object", - "x-ms-discriminator-value": "MicrosoftThreatProtection" - }, - "MTPCheckRequirementsProperties": { - "allOf": [ - { - "$ref": "#/definitions/DataConnectorTenantId" - } - ], - "description": "MTP (Microsoft Threat Protection) requirements check properties.", - "type": "object" - }, "ASCDataConnector": { "allOf": [ { @@ -2854,33 +2669,6 @@ }, "type": "object" }, - "ASCCheckRequirements": { - "allOf": [ - { - "$ref": "#/definitions/DataConnectorsCheckRequirements" - } - ], - "description": "Represents ASC (Azure Security Center) requirements check request.", - "properties": { - "properties": { - "$ref": "#/definitions/ASCCheckRequirementsProperties", - "description": "ASC (Azure Security Center) requirements check properties.", - "x-ms-client-flatten": true - } - }, - "type": "object", - "x-ms-discriminator-value": "AzureSecurityCenter" - }, - "ASCCheckRequirementsProperties": { - "description": "ASC (Azure Security Center) requirements check properties.", - "properties": { - "subscriptionId": { - "description": "The subscription id to connect to, and get the data from.", - "type": "string" - } - }, - "type": "object" - }, "AccountEntity": { "allOf": [ { @@ -2973,7 +2761,7 @@ "ActionRequest": { "allOf": [ { - "$ref": "#/definitions/ResourceWithEtag" + "$ref": "../../../common/1.0/types.json#/definitions/ResourceWithEtag" } ], "description": "Action for alert rule.", @@ -3068,6 +2856,7 @@ "type": "array" } }, + "type": "object", "required": [ "value" ] @@ -3242,6 +3031,7 @@ "type": "array" } }, + "type": "object", "required": [ "value" ] @@ -3276,6 +3066,7 @@ "type": "array" } }, + "type": "object", "required": [ "value" ] @@ -3405,16 +3196,6 @@ ], "type": "object" }, - "AwsCloudTrailCheckRequirements": { - "allOf": [ - { - "$ref": "#/definitions/DataConnectorsCheckRequirements" - } - ], - "description": "Amazon Web Services CloudTrail requirements check request.", - "type": "object", - "x-ms-discriminator-value": "AmazonWebServicesCloudTrail" - }, "AzureResourceEntity": { "allOf": [ { @@ -3664,64 +3445,6 @@ "kind" ] }, - "DataConnectorsCheckRequirements": { - "description": "Data connector requirements properties.", - "properties": { - "kind": { - "$ref": "#/definitions/DataConnectorKind", - "description": "Describes the kind of connector to be checked." - } - }, - "discriminator": "kind", - "type": "object", - "required": [ - "kind" - ] - }, - "DataConnectorAuthorizationState": { - "description": "Describes the state of user's authorization for a connector kind.", - "enum": [ - "Valid", - "Invalid" - ], - "type": "string", - "x-ms-enum": { - "modelAsString": true, - "name": "DataConnectorAuthorizationState", - "values": [ - { - "value": "Valid" - }, - { - "value": "Invalid" - } - ] - } - }, - "DataConnectorLicenseState": { - "description": "Describes the state of user's license for a connector kind.", - "enum": [ - "Valid", - "Invalid", - "Unknown" - ], - "type": "string", - "x-ms-enum": { - "modelAsString": true, - "name": "DataConnectorLicenseState", - "values": [ - { - "value": "Valid" - }, - { - "value": "Invalid" - }, - { - "value": "Unknown" - } - ] - } - }, "DataConnectorDataTypeCommon": { "description": "Common field for data type in data connectors.", "properties": { @@ -3832,24 +3555,11 @@ "type": "array" } }, + "type": "object", "required": [ "value" ] }, - "DataConnectorRequirementsState": { - "description": "Data connector requirements status.", - "properties": { - "authorizationState": { - "description": "Authorization state for this connector", - "$ref": "#/definitions/DataConnectorAuthorizationState" - }, - "licenseState": { - "description": "License state for this connector", - "$ref": "#/definitions/DataConnectorLicenseState" - } - }, - "type": "object" - }, "DataConnectorTenantId": { "description": "Properties data connector on tenant level.", "properties": { @@ -3978,32 +3688,6 @@ ], "type": "object" }, - "Dynamics365CheckRequirements": { - "allOf": [ - { - "$ref": "#/definitions/DataConnectorsCheckRequirements" - } - ], - "description": "Represents Dynamics365 requirements check request.", - "properties": { - "properties": { - "$ref": "#/definitions/Dynamics365CheckRequirementsProperties", - "description": "Dynamics365 requirements check properties.", - "x-ms-client-flatten": true - } - }, - "type": "object", - "x-ms-discriminator-value": "Dynamics365" - }, - "Dynamics365CheckRequirementsProperties": { - "allOf": [ - { - "$ref": "#/definitions/DataConnectorTenantId" - } - ], - "description": "Dynamics365 requirements check properties.", - "type": "object" - }, "Entity": { "allOf": [ { @@ -5094,6 +4778,7 @@ } } }, + "type": "object", "required": [ "value" ] @@ -5109,6 +4794,7 @@ } } }, + "type": "object", "required": [ "value" ] @@ -5145,6 +4831,7 @@ "type": "array" } }, + "type": "object", "required": [ "value" ] @@ -5182,6 +4869,7 @@ }, "IncidentEntitiesResponse": { "description": "The incident related entities response.", + "type": "object", "properties": { "entities": { "description": "Array of the incident related entities.", @@ -5270,6 +4958,7 @@ "type": "array" } }, + "type": "object", "required": [ "value" ] @@ -6157,32 +5846,6 @@ ], "type": "object" }, - "MCASCheckRequirements": { - "allOf": [ - { - "$ref": "#/definitions/DataConnectorsCheckRequirements" - } - ], - "description": "Represents MCAS (Microsoft Cloud App Security) requirements check request.", - "properties": { - "properties": { - "$ref": "#/definitions/MCASCheckRequirementsProperties", - "description": "MCAS (Microsoft Cloud App Security) requirements check properties.", - "x-ms-client-flatten": true - } - }, - "type": "object", - "x-ms-discriminator-value": "MicrosoftCloudAppSecurity" - }, - "MCASCheckRequirementsProperties": { - "allOf": [ - { - "$ref": "#/definitions/DataConnectorTenantId" - } - ], - "description": "MCAS (Microsoft Cloud App Security) requirements check properties.", - "type": "object" - }, "MDATPDataConnector": { "allOf": [ { @@ -6212,32 +5875,6 @@ "description": "MDATP (Microsoft Defender Advanced Threat Protection) data connector properties.", "type": "object" }, - "MDATPCheckRequirements": { - "allOf": [ - { - "$ref": "#/definitions/DataConnectorsCheckRequirements" - } - ], - "description": "Represents MDATP (Microsoft Defender Advanced Threat Protection) requirements check request.", - "properties": { - "properties": { - "$ref": "#/definitions/MDATPCheckRequirementsProperties", - "description": "MDATP (Microsoft Defender Advanced Threat Protection) requirements check properties.", - "x-ms-client-flatten": true - } - }, - "type": "object", - "x-ms-discriminator-value": "MicrosoftDefenderAdvancedThreatProtection" - }, - "MDATPCheckRequirementsProperties": { - "allOf": [ - { - "$ref": "#/definitions/DataConnectorTenantId" - } - ], - "description": "MDATP (Microsoft Defender Advanced Threat Protection) requirements check properties.", - "type": "object" - }, "MalwareEntity": { "allOf": [ { @@ -6457,32 +6094,6 @@ "description": "OfficeATP (Office 365 Advanced Threat Protection) data connector properties.", "type": "object" }, - "OfficeATPCheckRequirements": { - "allOf": [ - { - "$ref": "#/definitions/DataConnectorsCheckRequirements" - } - ], - "description": "Represents OfficeATP (Office 365 Advanced Threat Protection) requirements check request.", - "properties": { - "properties": { - "$ref": "#/definitions/OfficeATPCheckRequirementsProperties", - "description": "OfficeATP (Office 365 Advanced Threat Protection) requirements check properties.", - "x-ms-client-flatten": true - } - }, - "type": "object", - "x-ms-discriminator-value": "OfficeATP" - }, - "OfficeATPCheckRequirementsProperties": { - "allOf": [ - { - "$ref": "#/definitions/DataConnectorTenantId" - } - ], - "description": "OfficeATP (Office 365 Advanced Threat Protection) requirements check properties.", - "type": "object" - }, "OfficeDataConnector": { "allOf": [ { @@ -6606,6 +6217,7 @@ "type": "array" } }, + "type": "object", "required": [ "value" ] @@ -6914,6 +6526,7 @@ } } }, + "type": "object", "required": [ "value" ] @@ -7800,33 +7413,6 @@ "dataTypes" ] }, - "TICheckRequirements": { - "allOf": [ - { - "$ref": "#/definitions/DataConnectorsCheckRequirements" - } - ], - "description": "Threat Intelligence Platforms data connector check requirements", - "properties": { - "properties": { - "$ref": "#/definitions/TICheckRequirementsProperties", - "description": "Threat Intelligence Platforms data connector check required properties", - "x-ms-client-flatten": true - } - }, - "type": "object", - "x-ms-discriminator-value": "ThreatIntelligence" - }, - "TICheckRequirementsProperties": { - "allOf": [ - { - "$ref": "#/definitions/DataConnectorTenantId" - } - ], - "description": "Threat Intelligence Platforms data connector required properties.", - "properties": {}, - "type": "object" - }, "TiTaxiiDataConnector": { "allOf": [ { @@ -7939,32 +7525,6 @@ ], "type": "object" }, - "TiTaxiiCheckRequirements": { - "allOf": [ - { - "$ref": "#/definitions/DataConnectorsCheckRequirements" - } - ], - "description": "Threat Intelligence TAXII data connector check requirements", - "properties": { - "properties": { - "$ref": "#/definitions/TiTaxiiCheckRequirementsProperties", - "description": "Threat Intelligence TAXII check required properties.", - "x-ms-client-flatten": true - } - }, - "type": "object", - "x-ms-discriminator-value": "ThreatIntelligenceTaxii" - }, - "TiTaxiiCheckRequirementsProperties": { - "allOf": [ - { - "$ref": "#/definitions/DataConnectorTenantId" - } - ], - "description": "Threat Intelligence TAXII data connector required properties.", - "type": "object" - }, "ThreatIntelligence": { "description": "ThreatIntelligence property bag.", "properties": { @@ -8002,6 +7562,28 @@ }, "type": "object" }, + "UserInfo": { + "description": "User information that made some action", + "properties": { + "email": { + "description": "The email of the user.", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "The name of the user.", + "readOnly": true, + "type": "string" + }, + "objectId": { + "description": "The object id of the user.", + "format": "uuid", + "type": "string", + "x-nullable": true + } + }, + "type": "object" + }, "Anomalies": { "allOf": [ { @@ -8311,28 +7893,6 @@ }, "type": "object" }, - "UserInfo": { - "description": "User information that made some action", - "properties": { - "email": { - "description": "The email of the user.", - "readOnly": true, - "type": "string" - }, - "name": { - "description": "The name of the user.", - "readOnly": true, - "type": "string" - }, - "objectId": { - "description": "The object id of the user.", - "format": "uuid", - "type": "string", - "x-nullable": true - } - }, - "type": "object" - }, "IncidentInfo": { "description": "Describes related incident information for the bookmark", "properties": { @@ -8696,16 +8256,6 @@ "type": "string", "x-ms-parameter-location": "method" }, - "DataConnectorsCheckRequirementsBody": { - "description": "The parameters for requirements check message", - "in": "body", - "name": "DataConnectorsCheckRequirements", - "required": true, - "schema": { - "$ref": "#/definitions/DataConnectorsCheckRequirements" - }, - "x-ms-parameter-location": "method" - }, "EntityQueryId": { "description": "entity query ID", "in": "path", diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/OnboardingStates.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/OnboardingStates.json index 2687fa244506..78bc61a70678 100644 --- a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/OnboardingStates.json +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/OnboardingStates.json @@ -267,6 +267,7 @@ "type": "array" } }, + "type": "object", "required": [ "value" ] diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/Settings.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/Settings.json index a1d9dff393ef..3e2a7e3eb29b 100644 --- a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/Settings.json +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/Settings.json @@ -235,6 +235,7 @@ "type": "array" } }, + "type": "object", "required": [ "value" ] @@ -371,6 +372,7 @@ }, "UebaProperties": { "description": "Ueba property bag.", + "type": "object", "properties": { "dataSources": { "description": "The relevant data sources that enriched by ueba", @@ -415,7 +417,8 @@ "type": "integer", "format": "int32" } - } + }, + "type": "object" } }, "parameters": { diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/dataConnectors.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/dataConnectors.json index ff653f082db9..16e30dd98595 100644 --- a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/dataConnectors.json +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/dataConnectors.json @@ -711,6 +711,7 @@ "type": "array" } }, + "type": "object", "required": [ "value" ] diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/operations.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/operations.json index 865fba3331ce..376edf33331c 100644 --- a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/operations.json +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/operations.json @@ -83,6 +83,7 @@ "type": "array" } }, + "type": "object", "required": [ "value" ] @@ -120,7 +121,8 @@ "description": "The origin of the operation", "type": "string" } - } + }, + "type": "object" } }, "parameters": {} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2020-01-01/AlertRules.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2020-01-01/AlertRules.json index 5564565c1eec..ed000a7477c7 100644 --- a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2020-01-01/AlertRules.json +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2020-01-01/AlertRules.json @@ -536,6 +536,7 @@ "type": "array" } }, + "type": "object", "required": [ "value" ] @@ -759,6 +760,7 @@ "type": "array" } }, + "type": "object", "required": [ "value" ] @@ -779,6 +781,7 @@ "type": "array" } }, + "type": "object", "required": [ "value" ] diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2020-01-01/Bookmarks.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2020-01-01/Bookmarks.json index 61051726d2df..a3581ff591da 100644 --- a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2020-01-01/Bookmarks.json +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2020-01-01/Bookmarks.json @@ -253,6 +253,7 @@ "type": "array" } }, + "type": "object", "required": [ "value" ] diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2020-01-01/DataConnectors.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2020-01-01/DataConnectors.json index 4d6c9b276b03..4bfbc702611d 100644 --- a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2020-01-01/DataConnectors.json +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2020-01-01/DataConnectors.json @@ -475,6 +475,7 @@ "type": "array" } }, + "type": "object", "required": [ "value" ] diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2020-01-01/SecurityInsights.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2020-01-01/SecurityInsights.json index e0a84f111940..1bb0b3dff3b2 100644 --- a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2020-01-01/SecurityInsights.json +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2020-01-01/SecurityInsights.json @@ -475,6 +475,7 @@ "description": "The error object of the CloudError response" } }, + "type": "object", "description": "An error response for a resource management request." }, "Incident": { @@ -566,6 +567,7 @@ "type": "array" } }, + "type": "object", "required": [ "value" ] @@ -647,6 +649,7 @@ "type": "array" } }, + "type": "object", "required": [ "value" ] @@ -964,7 +967,8 @@ "description": "The origin of the operation", "type": "string" } - } + }, + "type": "object" }, "OperationsList": { "description": "Lists the operations available in the SecurityInsights RP.", @@ -981,6 +985,7 @@ "type": "array" } }, + "type": "object", "required": [ "value" ] @@ -1004,6 +1009,7 @@ "type": "string" } }, + "type": "object", "x-ms-azure-resource": true }, "ResourceWithEtag": { @@ -1029,6 +1035,7 @@ "type": "string" } }, + "type": "object", "x-ms-azure-resource": true }, "Settings": { diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/Incidents.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/Incidents.json index a44760474b59..26908cd90380 100644 --- a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/Incidents.json +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/Incidents.json @@ -51,10 +51,10 @@ "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/SubscriptionId" + "$ref": "../../../common/1.0/types.json#/parameters/SubscriptionId" }, { - "$ref": "#/parameters/ResourceGroupName" + "$ref": "../../../common/1.0/types.json#/parameters/ResourceGroupName" }, { "$ref": "../../../common/1.0/types.json#/parameters/WorkspaceName" @@ -108,10 +108,10 @@ "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/SubscriptionId" + "$ref": "../../../common/1.0/types.json#/parameters/SubscriptionId" }, { - "$ref": "#/parameters/ResourceGroupName" + "$ref": "../../../common/1.0/types.json#/parameters/ResourceGroupName" }, { "$ref": "../../../common/1.0/types.json#/parameters/WorkspaceName" @@ -151,10 +151,10 @@ "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/SubscriptionId" + "$ref": "../../../common/1.0/types.json#/parameters/SubscriptionId" }, { - "$ref": "#/parameters/ResourceGroupName" + "$ref": "../../../common/1.0/types.json#/parameters/ResourceGroupName" }, { "$ref": "../../../common/1.0/types.json#/parameters/WorkspaceName" @@ -203,10 +203,10 @@ "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/SubscriptionId" + "$ref": "../../../common/1.0/types.json#/parameters/SubscriptionId" }, { - "$ref": "#/parameters/ResourceGroupName" + "$ref": "../../../common/1.0/types.json#/parameters/ResourceGroupName" }, { "$ref": "../../../common/1.0/types.json#/parameters/WorkspaceName" @@ -248,10 +248,10 @@ "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/SubscriptionId" + "$ref": "../../../common/1.0/types.json#/parameters/SubscriptionId" }, { - "$ref": "#/parameters/ResourceGroupName" + "$ref": "../../../common/1.0/types.json#/parameters/ResourceGroupName" }, { "$ref": "../../../common/1.0/types.json#/parameters/WorkspaceName" @@ -293,10 +293,10 @@ "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/SubscriptionId" + "$ref": "../../../common/1.0/types.json#/parameters/SubscriptionId" }, { - "$ref": "#/parameters/ResourceGroupName" + "$ref": "../../../common/1.0/types.json#/parameters/ResourceGroupName" }, { "$ref": "../../../common/1.0/types.json#/parameters/WorkspaceName" @@ -338,10 +338,10 @@ "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/SubscriptionId" + "$ref": "../../../common/1.0/types.json#/parameters/SubscriptionId" }, { - "$ref": "#/parameters/ResourceGroupName" + "$ref": "../../../common/1.0/types.json#/parameters/ResourceGroupName" }, { "$ref": "../../../common/1.0/types.json#/parameters/WorkspaceName" @@ -399,10 +399,10 @@ "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/SubscriptionId" + "$ref": "../../../common/1.0/types.json#/parameters/SubscriptionId" }, { - "$ref": "#/parameters/ResourceGroupName" + "$ref": "../../../common/1.0/types.json#/parameters/ResourceGroupName" }, { "$ref": "../../../common/1.0/types.json#/parameters/WorkspaceName" @@ -445,10 +445,10 @@ "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/SubscriptionId" + "$ref": "../../../common/1.0/types.json#/parameters/SubscriptionId" }, { - "$ref": "#/parameters/ResourceGroupName" + "$ref": "../../../common/1.0/types.json#/parameters/ResourceGroupName" }, { "$ref": "../../../common/1.0/types.json#/parameters/WorkspaceName" @@ -500,10 +500,10 @@ "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/SubscriptionId" + "$ref": "../../../common/1.0/types.json#/parameters/SubscriptionId" }, { - "$ref": "#/parameters/ResourceGroupName" + "$ref": "../../../common/1.0/types.json#/parameters/ResourceGroupName" }, { "$ref": "../../../common/1.0/types.json#/parameters/WorkspaceName" @@ -548,10 +548,10 @@ "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/SubscriptionId" + "$ref": "../../../common/1.0/types.json#/parameters/SubscriptionId" }, { - "$ref": "#/parameters/ResourceGroupName" + "$ref": "../../../common/1.0/types.json#/parameters/ResourceGroupName" }, { "$ref": "../../../common/1.0/types.json#/parameters/WorkspaceName" @@ -593,10 +593,10 @@ "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/SubscriptionId" + "$ref": "../../../common/1.0/types.json#/parameters/SubscriptionId" }, { - "$ref": "#/parameters/ResourceGroupName" + "$ref": "../../../common/1.0/types.json#/parameters/ResourceGroupName" }, { "$ref": "../../../common/1.0/types.json#/parameters/WorkspaceName" @@ -654,10 +654,10 @@ "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/SubscriptionId" + "$ref": "../../../common/1.0/types.json#/parameters/SubscriptionId" }, { - "$ref": "#/parameters/ResourceGroupName" + "$ref": "../../../common/1.0/types.json#/parameters/ResourceGroupName" }, { "$ref": "../../../common/1.0/types.json#/parameters/WorkspaceName" @@ -700,10 +700,10 @@ "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/SubscriptionId" + "$ref": "../../../common/1.0/types.json#/parameters/SubscriptionId" }, { - "$ref": "#/parameters/ResourceGroupName" + "$ref": "../../../common/1.0/types.json#/parameters/ResourceGroupName" }, { "$ref": "../../../common/1.0/types.json#/parameters/WorkspaceName" @@ -755,10 +755,10 @@ "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/SubscriptionId" + "$ref": "../../../common/1.0/types.json#/parameters/SubscriptionId" }, { - "$ref": "#/parameters/ResourceGroupName" + "$ref": "../../../common/1.0/types.json#/parameters/ResourceGroupName" }, { "$ref": "../../../common/1.0/types.json#/parameters/WorkspaceName" @@ -1044,6 +1044,7 @@ "description": "The error object of the CloudError response" } }, + "type": "object", "description": "An error response for a resource management request." }, "DnsEntity": { @@ -1721,6 +1722,7 @@ } } }, + "type": "object", "required": [ "value" ] @@ -1757,6 +1759,7 @@ "type": "array" } }, + "type": "object", "required": [ "value" ] @@ -1794,6 +1797,7 @@ }, "IncidentEntitiesResponse": { "description": "The incident related entities response.", + "type": "object", "properties": { "entities": { "description": "Array of the incident related entities.", @@ -1937,6 +1941,7 @@ "type": "array" } }, + "type": "object", "required": [ "value" ] @@ -3160,6 +3165,7 @@ } } }, + "type": "object", "required": [ "value" ] @@ -3809,25 +3815,6 @@ "type": "string", "description": "Relation Name", "x-ms-parameter-location": "method" - }, - "ResourceGroupName": { - "description": "The name of the resource group within the user's subscription. The name is case insensitive.", - "in": "path", - "maxLength": 90, - "minLength": 1, - "name": "resourceGroupName", - "pattern": "^[-\\w\\._\\(\\)]+$", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "SubscriptionId": { - "description": "Azure subscription ID", - "in": "path", - "name": "subscriptionId", - "pattern": "^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$", - "required": true, - "type": "string" } } } diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/ThreatIntelligence.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/ThreatIntelligence.json new file mode 100644 index 000000000000..d8da42a17331 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/ThreatIntelligence.json @@ -0,0 +1,1183 @@ +{ + "swagger": "2.0", + "info": { + "title": "Security Insights", + "description": "API spec for Microsoft.SecurityInsights (Azure Security Insights) resource provider", + "version": "2021-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/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/threatIntelligence/main/createIndicator": { + "post": { + "x-ms-examples": { + "Create a new Threat Intelligence": { + "$ref": "./examples/threatintelligence/CreateThreatIntelligence.json" + } + }, + "tags": [ + "ThreatIntelligence" + ], + "description": "Create a new threat intelligence indicator.", + "operationId": "ThreatIntelligenceIndicator_CreateIndicator", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/SubscriptionId" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/ResourceGroupName" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/OperationalInsightsResourceProvider" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/ThreatIntelligenceProperties" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ThreatIntelligenceInformation" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/ThreatIntelligenceInformation" + } + }, + "default": { + "description": "Error response describing why the operation failed to create indicators.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/threatIntelligence/main/indicators": { + "get": { + "x-ms-examples": { + "Get all threat intelligence indicators": { + "$ref": "./examples/threatintelligence/GetThreatIntelligence.json" + } + }, + "tags": [ + "ThreatIntelligence" + ], + "description": "Get all threat intelligence indicators.", + "operationId": "ThreatIntelligenceIndicators_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/SubscriptionId" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/ResourceGroupName" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/OperationalInsightsResourceProvider" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/ODataFilter" + }, + { + "$ref": "#/parameters/ODataTop" + }, + { + "$ref": "#/parameters/ODataSkipToken" + }, + { + "$ref": "#/parameters/ODataOrderBy" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ThreatIntelligenceInformationList" + } + }, + "default": { + "description": "Error response describing why the operation failed to get indicators.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/threatIntelligence/main/indicators/{name}": { + "get": { + "x-ms-examples": { + "View a threat intelligence indicator by name": { + "$ref": "./examples/threatintelligence/GetThreatIntelligenceById.json" + } + }, + "tags": [ + "ThreatIntelligence" + ], + "description": "View a threat intelligence indicator by name.", + "operationId": "ThreatIntelligenceIndicator_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/SubscriptionId" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/ResourceGroupName" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/OperationalInsightsResourceProvider" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/ThreatIntelligenceName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ThreatIntelligenceInformation" + } + }, + "default": { + "description": "Error response describing why the operation failed to view an indicator.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "put": { + "x-ms-examples": { + "Update a threat Intelligence indicator": { + "$ref": "./examples/threatintelligence/UpdateThreatIntelligence.json" + } + }, + "tags": [ + "ThreatIntelligence" + ], + "description": "Update a threat Intelligence indicator.", + "operationId": "ThreatIntelligenceIndicator_Create", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/SubscriptionId" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/ResourceGroupName" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/OperationalInsightsResourceProvider" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/ThreatIntelligenceName" + }, + { + "$ref": "#/parameters/ThreatIntelligenceProperties" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ThreatIntelligenceInformation" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/ThreatIntelligenceInformation" + } + }, + "default": { + "description": "Error response describing why the operation failed to update an indicator.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "x-ms-examples": { + "Delete a threat intelligence indicator": { + "$ref": "./examples/threatintelligence/DeleteThreatIntelligence.json" + } + }, + "tags": [ + "ThreatIntelligence" + ], + "description": "Delete a threat intelligence indicator.", + "operationId": "ThreatIntelligenceIndicator_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/SubscriptionId" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/ResourceGroupName" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/OperationalInsightsResourceProvider" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/ThreatIntelligenceName" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed to delete an indicator.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/threatIntelligence/main/queryIndicators": { + "post": { + "x-ms-examples": { + "Query threat intelligence indicators as per filtering criteria": { + "$ref": "./examples/threatintelligence/QueryThreatIntelligence.json" + } + }, + "tags": [ + "ThreatIntelligence" + ], + "description": "Query threat intelligence indicators as per filtering criteria.", + "operationId": "ThreatIntelligenceIndicator_QueryIndicators", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/SubscriptionId" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/ResourceGroupName" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/OperationalInsightsResourceProvider" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/ThreatIntelligenceFilteringCriteria" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ThreatIntelligenceInformationList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/threatIntelligence/main/metrics": { + "get": { + "x-ms-examples": { + "Get threat intelligence indicators metrics.": { + "$ref": "./examples/threatintelligence/CollectThreatIntelligenceMetrics.json" + } + }, + "tags": [ + "ThreatIntelligence" + ], + "description": "Get threat intelligence indicators metrics (Indicators counts by Type, Threat Type, Source).", + "operationId": "ThreatIntelligenceIndicatorMetrics_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/SubscriptionId" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/ResourceGroupName" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/OperationalInsightsResourceProvider" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/WorkspaceName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ThreatIntelligenceMetricsList" + } + }, + "default": { + "description": "Error response describing why the operation failed to get metrics.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/threatIntelligence/main/indicators/{name}/appendTags": { + "post": { + "x-ms-examples": { + "Append tags to a threat intelligence indicator": { + "$ref": "./examples/threatintelligence/AppendTagsThreatIntelligence.json" + } + }, + "tags": [ + "ThreatIntelligence" + ], + "description": "Append tags to a threat intelligence indicator.", + "operationId": "ThreatIntelligenceIndicator_AppendTags", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/SubscriptionId" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/ResourceGroupName" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/OperationalInsightsResourceProvider" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/ThreatIntelligenceName" + }, + { + "$ref": "#/parameters/ThreatIntelligenceAppendTags" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "default": { + "description": "Error response describing why the operation failed to append tags.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/threatIntelligence/main/indicators/{name}/replaceTags": { + "post": { + "x-ms-examples": { + "Replace tags to a Threat Intelligence": { + "$ref": "./examples/threatintelligence/ReplaceTagsThreatIntelligence.json" + } + }, + "tags": [ + "ThreatIntelligence" + ], + "description": "Replace tags added to a threat intelligence indicator.", + "operationId": "ThreatIntelligenceIndicator_ReplaceTags", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/SubscriptionId" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/ResourceGroupName" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/OperationalInsightsResourceProvider" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/ThreatIntelligenceName" + }, + { + "$ref": "#/parameters/ThreatIntelligenceReplaceTags" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ThreatIntelligenceInformation" + } + }, + "default": { + "description": "Error response describing why the operation failed to replace tags.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + } + }, + "definitions": { + "CloudError": { + "x-ms-external": true, + "properties": { + "error": { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ErrorResponse", + "description": "The error object of the CloudError response" + } + }, + "description": "An error response for a resource management request." + }, + "ThreatIntelligenceInformation": { + "allOf": [ + { + "$ref": "../../../common/1.0/types.json#/definitions/ResourceWithEtag" + }, + { + "$ref": "#/definitions/ThreatIntelligenceResourceKind" + } + ], + "description": "Threat intelligence information object.", + "discriminator": "kind", + "type": "object", + "required": [ + "kind" + ] + }, + "ThreatIntelligenceInformationList": { + "description": "List of all the threat intelligence information objects.", + "properties": { + "nextLink": { + "description": "URL to fetch the next set of information objects.", + "readOnly": true, + "type": "string" + }, + "value": { + "description": "Array of threat intelligence information objects.", + "items": { + "$ref": "#/definitions/ThreatIntelligenceInformation" + }, + "type": "array" + } + }, + "type": "object", + "required": [ + "value" + ] + }, + "ThreatIntelligenceIndicatorModel": { + "allOf": [ + { + "$ref": "#/definitions/ThreatIntelligenceInformation" + } + ], + "description": "Threat intelligence indicator entity.", + "properties": { + "properties": { + "$ref": "#/definitions/ThreatIntelligenceIndicatorProperties", + "description": "Threat Intelligence Entity properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "indicator" + }, + "ThreatIntelligenceIndicatorModelForRequestBody": { + "allOf": [ + { + "$ref": "#/definitions/ThreatIntelligenceResourceKind" + } + ], + "description": "Threat intelligence indicator entity used in request body.", + "properties": { + "etag": { + "description": "Etag of the azure resource", + "type": "string" + }, + "properties": { + "$ref": "#/definitions/ThreatIntelligenceIndicatorProperties", + "description": "Threat Intelligence Entity properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "indicator" + }, + "ThreatIntelligenceResourceKind": { + "description": "Describes an entity with kind.", + "properties": { + "kind": { + "$ref": "#/definitions/ThreatIntelligenceResourceInnerKind", + "description": "The kind of the entity." + } + }, + "required": [ + "kind" + ], + "type": "object" + }, + "ThreatIntelligenceResourceInnerKind": { + "description": "The kind of the threat intelligence entity", + "enum": [ + "indicator" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "ThreatIntelligenceResourceInnerKind", + "values": [ + { + "description": "Entity represents threat intelligence indicator in the system.", + "value": "indicator" + } + ] + } + }, + "ThreatIntelligenceIndicatorProperties": { + "allOf": [ + { + "$ref": "../../../common/1.0/types.json#/definitions/EntityCommonProperties" + } + ], + "description": "Describes threat intelligence entity properties", + "properties": { + "threatIntelligenceTags": { + "description": "List of tags", + "items": { + "description": "tag", + "type": "string" + }, + "type": "array" + }, + "lastUpdatedTimeUtc": { + "description": "Last updated time in UTC", + "type": "string" + }, + "source": { + "description": "Source of a threat intelligence entity", + "type": "string" + }, + "displayName": { + "description": "Display name of a threat intelligence entity", + "type": "string" + }, + "description": { + "description": "Description of a threat intelligence entity", + "type": "string" + }, + "indicatorTypes": { + "description": "Indicator types of threat intelligence entities", + "items": { + "description": "Indicator type of a threat intelligence entity", + "type": "string" + }, + "type": "array" + }, + "pattern": { + "description": "Pattern of a threat intelligence entity", + "type": "string" + }, + "patternType": { + "description": "Pattern type of a threat intelligence entity", + "type": "string" + }, + "patternVersion": { + "description": "Pattern version of a threat intelligence entity", + "type": "string" + }, + "killChainPhases": { + "description": "Kill chain phases", + "items": { + "description": "Kill chain phase", + "$ref": "#/definitions/ThreatIntelligenceKillChainPhase" + }, + "type": "array" + }, + "parsedPattern": { + "description": "Parsed patterns", + "items": { + "description": "Parsed pattern", + "$ref": "#/definitions/ThreatIntelligenceParsedPattern" + }, + "type": "array" + }, + "externalId": { + "description": "External ID of threat intelligence entity", + "type": "string" + }, + "createdByRef": { + "description": "Created by reference of threat intelligence entity", + "type": "string" + }, + "defanged": { + "description": "Is threat intelligence entity defanged", + "type": "boolean" + }, + "externalLastUpdatedTimeUtc": { + "description": "External last updated time in UTC", + "type": "string" + }, + "externalReferences": { + "description": "External References", + "items": { + "description": "external_reference", + "$ref": "#/definitions/ThreatIntelligenceExternalReference" + }, + "type": "array" + }, + "granularMarkings": { + "description": "Granular Markings", + "items": { + "description": "Granular marking", + "$ref": "#/definitions/ThreatIntelligenceGranularMarkingModel" + }, + "type": "array" + }, + "labels": { + "description": "Labels of threat intelligence entity", + "items": { + "description": "label", + "type": "string" + }, + "type": "array" + }, + "revoked": { + "description": "Is threat intelligence entity revoked", + "type": "boolean" + }, + "confidence": { + "description": "Confidence of threat intelligence entity", + "type": "integer", + "format": "int32" + }, + "objectMarkingRefs": { + "description": "Threat intelligence entity object marking references", + "items": { + "description": "Threat intelligence entity object marking reference", + "type": "string" + }, + "type": "array" + }, + "language": { + "description": "Language of threat intelligence entity", + "type": "string" + }, + "threatTypes": { + "description": "Threat types", + "items": { + "description": "Threat type", + "type": "string" + }, + "type": "array" + }, + "validFrom": { + "description": "Valid from", + "type": "string" + }, + "validUntil": { + "description": "Valid until", + "type": "string" + }, + "created": { + "description": "Created by", + "type": "string" + }, + "modified": { + "description": "Modified by", + "type": "string" + }, + "extensions": { + "description": "Extensions map", + "type": "object", + "additionalProperties": {} + } + }, + "type": "object" + }, + "ThreatIntelligenceKillChainPhase": { + "description": "Describes threat kill chain phase entity", + "properties": { + "killChainName": { + "description": "Kill chainName name", + "type": "string" + }, + "phaseName": { + "description": "Phase name", + "type": "string" + } + }, + "type": "object" + }, + "ThreatIntelligenceParsedPattern": { + "description": "Describes parsed pattern entity", + "properties": { + "patternTypeKey": { + "description": "Pattern type key", + "type": "string" + }, + "patternTypeValues": { + "description": "Pattern type keys", + "items": { + "description": "Pattern type key", + "$ref": "#/definitions/ThreatIntelligenceParsedPatternTypeValue" + }, + "type": "array" + } + }, + "type": "object" + }, + "ThreatIntelligenceParsedPatternTypeValue": { + "description": "Describes threat kill chain phase entity", + "properties": { + "valueType": { + "description": "Type of the value", + "type": "string" + }, + "value": { + "description": "Value of parsed pattern", + "type": "string" + } + }, + "type": "object" + }, + "ThreatIntelligenceGranularMarkingModel": { + "description": "Describes threat granular marking model entity", + "properties": { + "language": { + "description": "Language granular marking model", + "type": "string" + }, + "markingRef": { + "description": "marking reference granular marking model", + "type": "integer", + "format": "int32" + }, + "selectors": { + "description": "granular marking model selectors", + "items": { + "description": "granular marking model selector", + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "ThreatIntelligenceExternalReference": { + "description": "Describes external reference", + "properties": { + "description": { + "description": "External reference description", + "type": "string" + }, + "externalId": { + "description": "External reference ID", + "type": "string" + }, + "sourceName": { + "description": "External reference source name", + "type": "string" + }, + "url": { + "description": "External reference URL", + "type": "string" + }, + "hashes": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "External reference hashes" + } + }, + "type": "object" + }, + "ThreatIntelligenceFilteringCriteria": { + "description": "Filtering criteria for querying threat intelligence indicators.", + "properties": { + "pageSize": { + "description": "Page size", + "type": "integer", + "format": "int32" + }, + "minConfidence": { + "description": "Minimum confidence.", + "type": "integer", + "format": "int32" + }, + "maxConfidence": { + "description": "Maximum confidence.", + "type": "integer", + "format": "int32" + }, + "minValidUntil": { + "description": "Start time for ValidUntil filter.", + "type": "string" + }, + "maxValidUntil": { + "description": "End time for ValidUntil filter.", + "type": "string" + }, + "includeDisabled": { + "description": "Parameter to include/exclude disabled indicators.", + "type": "boolean" + }, + "sortBy": { + "description": "Columns to sort by and sorting order", + "items": { + "description": "Sort By", + "$ref": "#/definitions/ThreatIntelligenceSortingCriteria" + }, + "type": "array" + }, + "sources": { + "description": "Sources of threat intelligence indicators", + "items": { + "description": "Source", + "type": "string" + }, + "type": "array" + }, + "patternTypes": { + "description": "Pattern types", + "items": { + "description": "Pattern type", + "type": "string" + }, + "type": "array" + }, + "threatTypes": { + "description": "Threat types of threat intelligence indicators", + "items": { + "description": "Threat type of a threat intelligence indicator", + "type": "string" + }, + "type": "array" + }, + "ids": { + "description": "Ids of threat intelligence indicators", + "items": { + "description": "Id of a threat intelligence indicator", + "type": "string" + }, + "type": "array" + }, + "keywords": { + "description": "Keywords for searching threat intelligence indicators", + "items": { + "description": "keyword for searching threat intelligence indicators", + "type": "string" + }, + "type": "array" + }, + "skipToken": { + "description": "Skip token.", + "type": "string" + } + }, + "type": "object" + }, + "ThreatIntelligenceSortingCriteria": { + "description": "List of available columns for sorting", + "properties": { + "itemKey": { + "description": "Column name", + "type": "string" + }, + "sortOrder": { + "$ref": "#/definitions/ThreatIntelligenceSortingOrder", + "description": "Sorting order (ascending/descending/unsorted)." + } + }, + "type": "object" + }, + "ThreatIntelligenceSortingOrder": { + "description": "Sorting order (ascending/descending/unsorted).", + "enum": [ + "unsorted", + "ascending", + "descending" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "ThreatIntelligenceSortingOrder", + "values": [ + { + "value": "unsorted" + }, + { + "value": "ascending" + }, + { + "value": "descending" + } + ] + } + }, + "ThreatIntelligenceAppendTags": { + "description": "Array of tags to be appended to the threat intelligence indicator.", + "properties": { + "threatIntelligenceTags": { + "description": "List of tags to be appended.", + "items": { + "description": "parameter", + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "ThreatIntelligenceMetricsList": { + "description": "List of all the threat intelligence metric fields (type/threat type/source).", + "properties": { + "value": { + "description": "Array of threat intelligence metric fields (type/threat type/source).", + "items": { + "$ref": "#/definitions/ThreatIntelligenceMetrics" + }, + "type": "array" + } + }, + "type": "object", + "required": [ + "value" + ] + }, + "ThreatIntelligenceMetrics": { + "description": "Threat intelligence metrics.", + "properties": { + "properties": { + "description": "Threat intelligence metrics.", + "$ref": "#/definitions/ThreatIntelligenceMetric" + } + }, + "type": "object" + }, + "ThreatIntelligenceMetric": { + "description": "Describes threat intelligence metric", + "properties": { + "lastUpdatedTimeUtc": { + "description": "Last updated indicator metric", + "type": "string" + }, + "threatTypeMetrics": { + "description": "Threat type metrics", + "items": { + "description": "parameter", + "$ref": "#/definitions/ThreatIntelligenceMetricEntity" + }, + "type": "array" + }, + "patternTypeMetrics": { + "description": "Pattern type metrics", + "items": { + "description": "parameter", + "$ref": "#/definitions/ThreatIntelligenceMetricEntity" + }, + "type": "array" + }, + "sourceMetrics": { + "description": "Source metrics", + "items": { + "description": "parameter", + "$ref": "#/definitions/ThreatIntelligenceMetricEntity" + }, + "type": "array" + } + }, + "type": "object" + }, + "ThreatIntelligenceMetricEntity": { + "description": "Describes threat intelligence metric entity", + "properties": { + "metricName": { + "description": "Metric name", + "type": "string" + }, + "metricValue": { + "description": "Metric value", + "type": "integer", + "format": "int32" + } + }, + "type": "object" + } + }, + "parameters": { + "OperationalInsightsResourceProvider": { + "description": "The namespace of workspaces resource provider- Microsoft.OperationalInsights.", + "in": "path", + "name": "operationalInsightsResourceProvider", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ThreatIntelligenceName": { + "description": "Threat intelligence indicator name field.", + "in": "path", + "name": "name", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ThreatIntelligenceProperties": { + "description": "Properties of threat intelligence indicators to create and update.", + "in": "body", + "name": "ThreatIntelligenceProperties", + "required": true, + "schema": { + "$ref": "#/definitions/ThreatIntelligenceIndicatorModelForRequestBody" + }, + "x-ms-parameter-location": "method" + }, + "ThreatIntelligenceReplaceTags": { + "description": "Tags in the threat intelligence indicator to be replaced.", + "in": "body", + "name": "ThreatIntelligenceReplaceTags", + "required": true, + "schema": { + "$ref": "#/definitions/ThreatIntelligenceIndicatorModelForRequestBody" + }, + "x-ms-parameter-location": "method" + }, + "ThreatIntelligenceFilteringCriteria": { + "description": "Filtering criteria for querying threat intelligence indicators.", + "in": "body", + "name": "ThreatIntelligenceFilteringCriteria", + "required": true, + "schema": { + "$ref": "#/definitions/ThreatIntelligenceFilteringCriteria" + }, + "x-ms-parameter-location": "method" + }, + "ThreatIntelligenceIndicatorEntityKind": { + "description": "The threat intelligence entity kind", + "in": "query", + "name": "ctiEntityKind", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ThreatIntelligenceAppendTags": { + "description": "The threat intelligence append tags request body", + "in": "body", + "name": "ThreatIntelligenceAppendTags", + "required": true, + "schema": { + "$ref": "#/definitions/ThreatIntelligenceAppendTags" + }, + "x-ms-parameter-location": "method" + }, + "ODataFilter": { + "description": "Filters the results, based on a Boolean condition. Optional.", + "in": "query", + "name": "$filter", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ODataOrderBy": { + "description": "Sorts the results. Optional.", + "in": "query", + "name": "$orderby", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ODataSkipToken": { + "description": "Skiptoken is only used if a previous operation returned 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. Optional.", + "in": "query", + "name": "$skipToken", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ODataTop": { + "description": "Returns only the first n results. Optional.", + "format": "int32", + "in": "query", + "name": "$top", + "required": false, + "type": "integer", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/Watchlists.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/Watchlists.json index 1ad2edd299e7..7a85c96421c6 100644 --- a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/Watchlists.json +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/Watchlists.json @@ -721,6 +721,7 @@ "description": "The error object of the CloudError response" } }, + "type": "object", "description": "An error response for a resource management request." } }, diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/examples/threatintelligence/AppendTagsThreatIntelligence.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/examples/threatintelligence/AppendTagsThreatIntelligence.json new file mode 100644 index 000000000000..46520a2dee24 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/examples/threatintelligence/AppendTagsThreatIntelligence.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2021-04-01", + "subscriptionId": "bd794837-4d29-4647-9105-6339bfdb4e6a", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "operationalInsightsResourceProvider": "Microsoft.OperationalInsights", + "name": "d9cd6f0b-96b9-3984-17cd-a779d1e15a93", + "ThreatIntelligenceAppendTags": { + "threatIntelligenceTags": [ + "tag1", + "tag2" + ] + } + }, + "responses": { + "200": {} + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/examples/threatintelligence/CollectThreatIntelligenceMetrics.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/examples/threatintelligence/CollectThreatIntelligenceMetrics.json new file mode 100644 index 000000000000..c882bf917564 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/examples/threatintelligence/CollectThreatIntelligenceMetrics.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2021-04-01", + "subscriptionId": "bd794837-4d29-4647-9105-6339bfdb4e6a", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "operationalInsightsResourceProvider": "Microsoft.OperationalInsights" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "lastUpdatedTimeUtc": "2020-09-01T19:44:44.117403Z", + "threatTypeMetrics": [ + { + "metricName": "compromised", + "metricValue": 20 + } + ], + "patternTypeMetrics": [ + { + "metricName": "url", + "metricValue": 20 + } + ], + "sourceMetrics": [ + { + "metricName": "Azure Sentinel", + "metricValue": 10315 + }, + { + "metricName": "zinga", + "metricValue": 2 + } + ] + } + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/examples/threatintelligence/CreateThreatIntelligence.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/examples/threatintelligence/CreateThreatIntelligence.json new file mode 100644 index 000000000000..cc69d35bef66 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/examples/threatintelligence/CreateThreatIntelligence.json @@ -0,0 +1,101 @@ +{ + "parameters": { + "api-version": "2021-04-01", + "subscriptionId": "bd794837-4d29-4647-9105-6339bfdb4e6a", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "operationalInsightsResourceProvider": "Microsoft.OperationalInsights", + "ThreatIntelligenceProperties": { + "kind": "indicator", + "properties": { + "source": "Azure Sentinel", + "threatIntelligenceTags": [ + "new schema" + ], + "displayName": "new schema", + "confidence": 78, + "createdByRef": "contoso@contoso.com", + "description": "debugging indicators", + "externalReferences": [], + "granularMarkings": [], + "threatTypes": [ + "compromised" + ], + "killChainPhases": [], + "labels": [], + "modified": "", + "pattern": "[url:value = 'https://www.contoso.com']", + "patternType": "url", + "revoked": false, + "validFrom": "2020-04-15T17:44:00.114052Z", + "validUntil": "" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/bd794837-4d29-4647-9105-6339bfdb4e6a/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/ThreatIntelligence/180105c7-a28d-b1a2-4a78-234f6ec80fd6", + "name": "180105c7-a28d-b1a2-4a78-234f6ec80fd6", + "etag": "\"0000322c-0000-0800-0000-5e976c960000\"", + "type": "Microsoft.SecurityInsights/ThreatIntelligence", + "kind": "indicator", + "properties": { + "confidence": 78, + "created": "2020-04-15T20:20:38.6160949Z", + "createdByRef": "contoso@contoso.com", + "externalId": "indicator--a2b6a95e-2108-4a38-bd49-ef95811bbcd7", + "externalReferences": [], + "granularMarkings": [], + "lastUpdatedTimeUtc": "2020-04-15T20:20:38.6161887Z", + "revoked": false, + "source": "Azure Sentinel", + "threatIntelligenceTags": [ + "new schema" + ], + "displayName": "new schema", + "description": "debugging indicators", + "threatTypes": [ + "compromised" + ], + "killChainPhases": [], + "pattern": "[url:value = 'https://www.contoso.com']", + "patternType": "url", + "validFrom": "2020-04-15T17:44:00.114052Z" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/bd794837-4d29-4647-9105-6339bfdb4e6a/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/ThreatIntelligence/180105c7-a28d-b1a2-4a78-234f6ec80fd6", + "name": "180105c7-a28d-b1a2-4a78-234f6ec80fd6", + "etag": "\"0000322c-0000-0800-0000-5e976c960000\"", + "type": "Microsoft.SecurityInsights/ThreatIntelligence", + "kind": "indicator", + "properties": { + "confidence": 78, + "created": "2020-04-15T20:20:38.6160949Z", + "createdByRef": "aztestConnectors@contoso.com", + "externalId": "indicator--a2b6a95e-2108-4a38-bd49-ef95811bbcd7", + "externalReferences": [], + "granularMarkings": [], + "lastUpdatedTimeUtc": "2020-04-15T20:20:38.6161887Z", + "revoked": false, + "source": "Azure Sentinel", + "threatIntelligenceTags": [ + "new schema" + ], + "displayName": "new schema", + "description": "debugging indicators", + "threatTypes": [ + "compromised" + ], + "killChainPhases": [], + "pattern": "[url:value = 'https://www.contoso.com']", + "patternType": "url", + "validFrom": "2020-04-15T17:44:00.114052Z" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/examples/threatintelligence/DeleteThreatIntelligence.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/examples/threatintelligence/DeleteThreatIntelligence.json new file mode 100644 index 000000000000..ca06dedb2118 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/examples/threatintelligence/DeleteThreatIntelligence.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "api-version": "2021-04-01", + "subscriptionId": "bd794837-4d29-4647-9105-6339bfdb4e6a", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "operationalInsightsResourceProvider": "Microsoft.OperationalInsights", + "name": "d9cd6f0b-96b9-3984-17cd-a779d1e15a93" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/examples/threatintelligence/GetThreatIntelligence.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/examples/threatintelligence/GetThreatIntelligence.json new file mode 100644 index 000000000000..0264247c2583 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/examples/threatintelligence/GetThreatIntelligence.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "api-version": "2021-04-01", + "subscriptionId": "bd794837-4d29-4647-9105-6339bfdb4e6a", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "operationalInsightsResourceProvider": "Microsoft.OperationalInsights" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/bd794837-4d29-4647-9105-6339bfdb4e6a/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/ThreatIntelligence/27d963e6-e6e4-e0f9-e9d7-c53985b3bbe8", + "name": "27d963e6-e6e4-e0f9-e9d7-c53985b3bbe8", + "etag": "\"00002f2c-0000-0800-0000-5e976a8e0000\"", + "type": "Microsoft.SecurityInsights/ThreatIntelligence", + "kind": "indicator", + "properties": { + "confidence": 90, + "created": "2020-04-15T20:11:57.9666134Z", + "createdByRef": "contoso@contoso.com", + "externalId": "indicator--8516d567-0daa-4614-8745-e3591e1b48cf", + "externalReferences": [], + "granularMarkings": [], + "lastUpdatedTimeUtc": "2020-04-15T20:15:11.0746926Z", + "revoked": false, + "source": "Azure Sentinel", + "threatIntelligenceTags": [ + "new schema" + ], + "displayName": "new schema 2", + "description": "debugging indicators", + "threatTypes": [ + "compromised" + ], + "killChainPhases": [], + "pattern": "[url:value = 'https://www.contoso.com']", + "patternType": "url", + "validFrom": "2020-04-15T17:44:00.114052Z" + } + }, + { + "id": "/subscriptions/bd794837-4d29-4647-9105-6339bfdb4e6a/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/ThreatIntelligence/e16ef847-962e-d7b6-9c8b-a33e4bd30e47", + "name": "e16ef847-962e-d7b6-9c8b-a33e4bd30e47", + "etag": "\"00002a2c-0000-0800-0000-5e97683b0000\"", + "type": "Microsoft.SecurityInsights/ThreatIntelligence", + "kind": "indicator", + "properties": { + "confidence": 78, + "created": "2020-04-15T19:51:17.1050923Z", + "createdByRef": "contoso@contoso.com", + "externalId": "indicator--73be1729-babb-4348-a6c4-94621cae2530", + "externalReferences": [], + "granularMarkings": [], + "lastUpdatedTimeUtc": "2020-04-15T20:15:11.074903Z", + "revoked": false, + "source": "Azure Sentinel", + "threatIntelligenceTags": [ + "patching tags" + ], + "displayName": "updated indicator", + "description": "debugging indicators", + "threatTypes": [ + "compromised" + ], + "killChainPhases": [], + "pattern": "[url:value = 'https://www.contoso.com']", + "patternType": "url", + "validFrom": "2020-04-15T17:44:00.114052Z" + } + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/examples/threatintelligence/GetThreatIntelligenceById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/examples/threatintelligence/GetThreatIntelligenceById.json new file mode 100644 index 000000000000..7334c9ea292c --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/examples/threatintelligence/GetThreatIntelligenceById.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2021-04-01", + "subscriptionId": "bd794837-4d29-4647-9105-6339bfdb4e6a", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "operationalInsightsResourceProvider": "Microsoft.OperationalInsights", + "name": "e16ef847-962e-d7b6-9c8b-a33e4bd30e47" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/bd794837-4d29-4647-9105-6339bfdb4e6a/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/ThreatIntelligence/e16ef847-962e-d7b6-9c8b-a33e4bd30e47", + "name": "e16ef847-962e-d7b6-9c8b-a33e4bd30e47", + "etag": "\"00002a2c-0000-0800-0000-5e97683b0000\"", + "type": "Microsoft.SecurityInsights/ThreatIntelligence", + "kind": "indicator", + "properties": { + "confidence": 78, + "created": "2020-04-15T19:51:17.1050923Z", + "createdByRef": "aztestConnectors@dataconnector.ccsctp.net", + "externalId": "indicator--73be1729-babb-4348-a6c4-94621cae2530", + "externalReferences": [], + "granularMarkings": [], + "lastUpdatedTimeUtc": "2020-04-15T20:18:49.2259902Z", + "revoked": false, + "source": "Azure Sentinel", + "threatIntelligenceTags": [ + "patching tags" + ], + "displayName": "updated indicator", + "description": "debugging indicators", + "threatTypes": [ + "compromised" + ], + "killChainPhases": [], + "pattern": "[url:value = 'https://abc.com']", + "patternType": "url", + "validFrom": "2020-04-15T17:44:00.114052Z" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/examples/threatintelligence/QueryThreatIntelligence.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/examples/threatintelligence/QueryThreatIntelligence.json new file mode 100644 index 000000000000..2ebf72628dfb --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/examples/threatintelligence/QueryThreatIntelligence.json @@ -0,0 +1,108 @@ +{ + "parameters": { + "api-version": "2021-04-01", + "subscriptionId": "bd794837-4d29-4647-9105-6339bfdb4e6a", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "operationalInsightsResourceProvider": "Microsoft.OperationalInsights", + "ThreatIntelligenceFilteringCriteria": { + "pageSize": 100, + "minConfidence": 25, + "maxConfidence": 80, + "minValidUntil": "2020-04-05T17:44:00.114052Z", + "maxValidUntil": "2020-04-25T17:44:00.114052Z", + "sources": [ + "Azure Sentinel" + ], + "sortBy": [ + { + "itemKey": "lastUpdatedTimeUtc", + "sortOrder": "descending" + } + ] + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/bd794837-4d29-4647-9105-6339bfdb4e6a/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/ThreatIntelligence/27d963e6-e6e4-e0f9-e9d7-c53985b3bbe8", + "name": "27d963e6-e6e4-e0f9-e9d7-c53985b3bbe8", + "etag": "\"00002f2c-0000-0800-0000-5e976a8e0000\"", + "type": "Microsoft.SecurityInsights/ThreatIntelligence", + "kind": "indicator", + "properties": { + "confidence": 90, + "created": "2020-04-15T20:11:57.9666134Z", + "createdByRef": "contoso@contoso.com", + "externalId": "indicator--8516d567-0daa-4614-8745-e3591e1b48cf", + "externalReferences": [], + "granularMarkings": [], + "lastUpdatedTimeUtc": "2020-04-15T20:15:11.0746926Z", + "revoked": false, + "source": "Azure Sentinel", + "threatIntelligenceTags": [ + "new schema" + ], + "displayName": "new schema 2", + "description": "debugging indicators 2", + "threatTypes": [ + "compromised" + ], + "killChainPhases": [], + "pattern": "[url:value = 'https://www.contoso.com']", + "patternType": "url", + "validFrom": "2020-04-15T17:44:00.114052Z", + "parsedPattern": [ + { + "patternTypeKey": "network-traffic", + "patternTypeValues": [ + { + "valueType": "0", + "value": "SSH-2.0-PuTTY_Release_0.64" + }, + { + "valueType": "1", + "value": "194.88.106.146" + } + ] + } + ] + } + }, + { + "id": "/subscriptions/bd794837-4d29-4647-9105-6339bfdb4e6a/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/ThreatIntelligence/e16ef847-962e-d7b6-9c8b-a33e4bd30e47", + "name": "e16ef847-962e-d7b6-9c8b-a33e4bd30e47", + "etag": "\"00002a2c-0000-0800-0000-5e97683b0000\"", + "type": "Microsoft.SecurityInsights/ThreatIntelligence", + "kind": "indicator", + "properties": { + "confidence": 78, + "created": "2020-04-15T19:51:17.1050923Z", + "createdByRef": "contoso@contoso.com", + "externalId": "indicator--73be1729-babb-4348-a6c4-94621cae2530", + "externalReferences": [], + "granularMarkings": [], + "lastUpdatedTimeUtc": "2020-04-15T20:15:11.074903Z", + "revoked": false, + "source": "Azure Sentinel", + "threatIntelligenceTags": [ + "patching tags" + ], + "displayName": "updated indicator", + "description": "debugging indicators", + "threatTypes": [ + "compromised" + ], + "killChainPhases": [], + "pattern": "[url:value = 'https://www.contoso.com']", + "patternType": "url", + "validFrom": "2020-04-15T17:44:00.114052Z" + } + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/examples/threatintelligence/ReplaceTagsThreatIntelligence.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/examples/threatintelligence/ReplaceTagsThreatIntelligence.json new file mode 100644 index 000000000000..4ac662492954 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/examples/threatintelligence/ReplaceTagsThreatIntelligence.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "api-version": "2021-04-01", + "subscriptionId": "bd794837-4d29-4647-9105-6339bfdb4e6a", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "operationalInsightsResourceProvider": "Microsoft.OperationalInsights", + "name": "d9cd6f0b-96b9-3984-17cd-a779d1e15a93", + "ThreatIntelligenceReplaceTags": { + "etag": "\"0000262c-0000-0800-0000-5e9767060000\"", + "kind": "indicator", + "properties": { + "threatIntelligenceTags": [ + "patching tags" + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/bd794837-4d29-4647-9105-6339bfdb4e6a/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/ThreatIntelligence/e16ef847-962e-d7b6-9c8b-a33e4bd30e47", + "name": "e16ef847-962e-d7b6-9c8b-a33e4bd30e47", + "etag": "\"00002a2c-0000-0800-0000-5e97683b0000\"", + "type": "Microsoft.SecurityInsights/ThreatIntelligence", + "kind": "indicator", + "properties": { + "confidence": 78, + "created": "2020-04-15T19:51:17.1050923Z", + "createdByRef": "aztestConnectors@dataconnector.ccsctp.net", + "externalId": "indicator--73be1729-babb-4348-a6c4-94621cae2530", + "externalReferences": [], + "granularMarkings": [], + "lastUpdatedTimeUtc": "2020-04-15T19:56:08.828946Z", + "revoked": false, + "source": "Azure Sentinel", + "threatIntelligenceTags": [ + "patching tags" + ], + "displayName": "updated indicator", + "description": "debugging indicators", + "threatTypes": [ + "compromised" + ], + "killChainPhases": [], + "pattern": "[url:value = 'https://abc.com']", + "patternType": "url", + "validFrom": "2020-04-15T17:44:00.114052Z" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/examples/threatintelligence/UpdateThreatIntelligence.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/examples/threatintelligence/UpdateThreatIntelligence.json new file mode 100644 index 000000000000..b020c1b9ae1c --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/examples/threatintelligence/UpdateThreatIntelligence.json @@ -0,0 +1,102 @@ +{ + "parameters": { + "api-version": "2021-04-01", + "subscriptionId": "bd794837-4d29-4647-9105-6339bfdb4e6a", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "operationalInsightsResourceProvider": "Microsoft.OperationalInsights", + "name": "d9cd6f0b-96b9-3984-17cd-a779d1e15a93", + "ThreatIntelligenceProperties": { + "kind": "indicator", + "properties": { + "source": "Azure Sentinel", + "threatIntelligenceTags": [ + "new schema" + ], + "displayName": "new schema", + "confidence": 78, + "createdByRef": "contoso@contoso.com", + "description": "debugging indicators", + "externalReferences": [], + "granularMarkings": [], + "threatTypes": [ + "compromised" + ], + "killChainPhases": [], + "labels": [], + "modified": "", + "pattern": "[url:value = 'https://www.contoso.com']", + "patternType": "url", + "revoked": false, + "validFrom": "2020-04-15T17:44:00.114052Z", + "validUntil": "" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/bd794837-4d29-4647-9105-6339bfdb4e6a/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/ThreatIntelligence/180105c7-a28d-b1a2-4a78-234f6ec80fd6", + "name": "180105c7-a28d-b1a2-4a78-234f6ec80fd6", + "etag": "\"0000322c-0000-0800-0000-5e976c960000\"", + "type": "Microsoft.SecurityInsights/ThreatIntelligence", + "kind": "indicator", + "properties": { + "confidence": 78, + "created": "2020-04-15T20:20:38.6160949Z", + "createdByRef": "contoso@contoso.com", + "externalId": "indicator--a2b6a95e-2108-4a38-bd49-ef95811bbcd7", + "externalReferences": [], + "granularMarkings": [], + "lastUpdatedTimeUtc": "2020-04-15T20:20:38.6161887Z", + "revoked": false, + "source": "Azure Sentinel", + "threatIntelligenceTags": [ + "new schema" + ], + "displayName": "new schema", + "description": "debugging indicators", + "threatTypes": [ + "compromised" + ], + "killChainPhases": [], + "pattern": "[url:value = 'https://www.contoso.com']", + "patternType": "url", + "validFrom": "2020-04-15T17:44:00.114052Z" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/bd794837-4d29-4647-9105-6339bfdb4e6a/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/ThreatIntelligence/180105c7-a28d-b1a2-4a78-234f6ec80fd6", + "name": "180105c7-a28d-b1a2-4a78-234f6ec80fd6", + "etag": "\"0000322c-0000-0800-0000-5e976c960000\"", + "type": "Microsoft.SecurityInsights/ThreatIntelligence", + "kind": "indicator", + "properties": { + "confidence": 78, + "created": "2020-04-15T20:20:38.6160949Z", + "createdByRef": "aztestConnectors@contoso.com", + "externalId": "indicator--a2b6a95e-2108-4a38-bd49-ef95811bbcd7", + "externalReferences": [], + "granularMarkings": [], + "lastUpdatedTimeUtc": "2020-04-15T20:20:38.6161887Z", + "revoked": false, + "source": "Azure Sentinel", + "threatIntelligenceTags": [ + "new schema" + ], + "displayName": "new schema", + "description": "debugging indicators", + "threatTypes": [ + "compromised" + ], + "killChainPhases": [], + "pattern": "[url:value = 'https://www.contoso.com']", + "patternType": "url", + "validFrom": "2020-04-15T17:44:00.114052Z" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/operations.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/operations.json index 55fcc4edc101..0808512d4977 100644 --- a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/operations.json +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/operations.json @@ -75,6 +75,7 @@ "description": "The error object of the CloudError response" } }, + "type": "object", "description": "An error response for a resource management request." }, "OperationsList": { @@ -93,6 +94,7 @@ "type": "array" } }, + "type": "object", "required": [ "value" ] @@ -130,7 +132,8 @@ "description": "The origin of the operation", "type": "string" } - } + }, + "type": "object" } }, "parameters": {} diff --git a/specification/securityinsights/resource-manager/common/1.0/types.json b/specification/securityinsights/resource-manager/common/1.0/types.json index 5e0826d07a40..c7e07346ddb7 100644 --- a/specification/securityinsights/resource-manager/common/1.0/types.json +++ b/specification/securityinsights/resource-manager/common/1.0/types.json @@ -35,6 +35,25 @@ "type": "object", "x-ms-external": true }, + "EntityCommonProperties": { + "description": "Entity common property bag.", + "properties": { + "additionalData": { + "additionalProperties": { + "type": "object" + }, + "description": "A bag of custom fields that should be part of the entity and will be presented to the user.", + "readOnly": true, + "type": "object" + }, + "friendlyName": { + "description": "The graph item display name which is a short humanly readable description of the graph item instance. This property is optional and might be system generated.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "ResourceWithEtag": { "allOf": [ { @@ -47,7 +66,8 @@ "description": "Etag of the azure resource", "type": "string" } - } + }, + "type": "object" }, "Resource": { "description": "An azure resource object", @@ -74,6 +94,7 @@ "$ref": "../../../../common-types/resource-management/v2/types.json#/definitions/systemData" } }, + "type": "object", "x-ms-azure-resource": true } }, @@ -96,6 +117,25 @@ "type": "string", "x-ms-parameter-location": "method" }, + "ResourceGroupName": { + "description": "The name of the resource group within the user's subscription. The name is case insensitive.", + "in": "path", + "maxLength": 90, + "minLength": 1, + "name": "resourceGroupName", + "pattern": "^[-\\w\\._\\(\\)]+$", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "SubscriptionId": { + "description": "Azure subscription ID", + "in": "path", + "name": "subscriptionId", + "pattern": "^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$", + "required": true, + "type": "string" + }, "ODataFilter": { "description": "Filters the results, based on a Boolean condition. Optional.", "in": "query", diff --git a/specification/securityinsights/resource-manager/readme.md b/specification/securityinsights/resource-manager/readme.md index 81844307c00e..b4df8c820c71 100644 --- a/specification/securityinsights/resource-manager/readme.md +++ b/specification/securityinsights/resource-manager/readme.md @@ -57,6 +57,8 @@ input-file: - Microsoft.SecurityInsights/stable/2021-04-01/Incidents.json - Microsoft.SecurityInsights/stable/2021-04-01/operations.json - Microsoft.SecurityInsights/stable/2021-04-01/Watchlists.json +- Microsoft.SecurityInsights/stable/2021-04-01/ThreatIntelligence.json + directive: - suppress: R4017 from: Microsoft.SecurityInsights/stable/2021-04-01/Incidents.json @@ -165,6 +167,7 @@ input-file: - Microsoft.SecurityInsights/preview/2019-01-01-preview/AutomationRules.json - Microsoft.SecurityInsights/preview/2019-01-01-preview/Bookmarks.json - Microsoft.SecurityInsights/preview/2019-01-01-preview/Cases.json +- Microsoft.SecurityInsights/preview/2019-01-01-preview/DataConnectorsCheckRequirements.json - Microsoft.SecurityInsights/preview/2019-01-01-preview/Enrichment.json - Microsoft.SecurityInsights/preview/2019-01-01-preview/Entities.json - Microsoft.SecurityInsights/preview/2019-01-01-preview/OfficeConsents.json diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2020-05-01/signalr.json b/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2020-05-01/signalr.json index 0083c536e227..8d70306668fe 100644 --- a/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2020-05-01/signalr.json +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2020-05-01/signalr.json @@ -1418,7 +1418,8 @@ "enum": [ "ClientConnection", "ServerConnection", - "RESTAPI" + "RESTAPI", + "Trace" ], "type": "string", "x-ms-enum": { diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2021-02-01-preview/LedgerDigestUploads.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2021-02-01-preview/LedgerDigestUploads.json index 5a1e1d03fe00..270fdce755ac 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2021-02-01-preview/LedgerDigestUploads.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2021-02-01-preview/LedgerDigestUploads.json @@ -61,7 +61,7 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 LedgerInvalidDigestStorageTargetUpdateRequest - The database ledger digest storage upload request does not exist or has no properties object.\n\n * 400 InvalidDigestStorageEndpoint - The specified digestStorageEndpoint is invalid. It must be an Azure blob storage endpoint.\n\n * 400 MalformedDigestStorageEndpoint - The specified digest storage endpoint is a malformed URI.\n\n * 400 InvalidLedgerDigestUploadsName - The ledger digest upload name is not supported. Please use the key name “current”.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription." + "description": "*** Error Responses: ***\n\n * 400 LedgerInvalidDigestStorageTargetUpdateRequest - The database ledger digest storage upload request does not exist or has no properties object.\n\n * 400 InvalidDigestStorageEndpoint - The specified digestStorageEndpoint is invalid. It must be an Azure blob storage endpoint.\n\n * 400 MalformedDigestStorageEndpoint - The specified digest storage endpoint is a malformed URI.\n\n * 400 InvalidLedgerDigestUploadsName - The ledger digest upload name is not supported. Please use the key name “current”.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found" } }, "x-ms-examples": { @@ -122,12 +122,13 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 LedgerInvalidDigestStorageTargetUpdateRequest - The database ledger digest storage upload request does not exist or has no properties object.\n\n * 400 InvalidDigestStorageEndpoint - The specified digestStorageEndpoint is invalid. It must be an Azure blob storage endpoint.\n\n * 400 MalformedDigestStorageEndpoint - The specified digest storage endpoint is a malformed URI.\n\n * 400 InvalidLedgerDigestUploadsName - The ledger digest upload name is not supported. Please use the key name “current”.\n\n * 400 InvalidStorageAccountName - The specified storage account is not valid or does not exist.\n\n * 400 NoServerIdentity - No identity is configured for specified server. For information on how to configure an identity for the server see https://go.microsoft.com/fwlink/?linkid=2156804\n\n * 400 SubscriptionDoesNotHaveServer - Subscription {0} does not contain server {1}.\n\n * 400 AdalGenericError - The operation could not be completed because an Azure Active Directory error was encountered. The error message from Active Directory Authentication library (ADAL) is {0}.\n\n * 400 InsufficientStorageAccountPermissions - Read or write operations are not allowed on the storage account {0}.\n\n * 400 StorageAccountIsDisabled - The storage account {0} is disabled.\n\n * 404 SourceDatabaseNotFound - Specified database does not exist.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription." + "description": "*** Error Responses: ***\n\n * 400 LedgerInvalidDigestStorageTargetUpdateRequest - The database ledger digest storage upload request does not exist or has no properties object.\n\n * 400 InvalidDigestStorageEndpoint - The specified digestStorageEndpoint is invalid. It must be an Azure blob storage endpoint.\n\n * 400 MalformedDigestStorageEndpoint - The specified digest storage endpoint is a malformed URI.\n\n * 400 InvalidLedgerDigestUploadsName - The ledger digest upload name is not supported. Please use the key name “current”.\n\n * 400 NoServerIdentity - No identity is configured for specified server. For information on how to configure an identity for the server see https://go.microsoft.com/fwlink/?linkid=2156804\n\n * 400 InsufficientStorageAccountPermissions - Read or write operations are not allowed on the storage account {0}.\n\n * 400 StorageAccountIsDisabled - The storage account {0} is disabled.\n\n * 400 AdalGenericError - The operation could not be completed because an Azure Active Directory error was encountered. The error message from Active Directory Authentication library (ADAL) is {0}.\n\n * 400 SubscriptionDoesNotHaveServer - Subscription {0} does not contain server {1}.\n\n * 400 InvalidStorageAccountName - The specified storage account is not valid or does not exist.\n\n * 404 SourceDatabaseNotFound - Specified database does not exist.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found" }, "202": { "description": "Updating the ledger digest upload configuration is in progress." } }, + "x-ms-long-running-operation": true, "x-ms-examples": { "Enables ledger digest upload configuration for a database": { "$ref": "./examples/LedgerDigestUploadsEnable.json" @@ -225,12 +226,13 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 LedgerInvalidDigestStorageTargetUpdateRequest - The database ledger digest storage upload request does not exist or has no properties object.\n\n * 400 InvalidDigestStorageEndpoint - The specified digestStorageEndpoint is invalid. It must be an Azure blob storage endpoint.\n\n * 400 MalformedDigestStorageEndpoint - The specified digest storage endpoint is a malformed URI.\n\n * 400 InvalidLedgerDigestUploadsName - The ledger digest upload name is not supported. Please use the key name “current”.\n\n * 400 InvalidStorageAccountName - The specified storage account is not valid or does not exist.\n\n * 400 NoServerIdentity - No identity is configured for specified server. For information on how to configure an identity for the server see https://go.microsoft.com/fwlink/?linkid=2156804\n\n * 400 SubscriptionDoesNotHaveServer - Subscription {0} does not contain server {1}.\n\n * 400 AdalGenericError - The operation could not be completed because an Azure Active Directory error was encountered. The error message from Active Directory Authentication library (ADAL) is {0}.\n\n * 400 InsufficientStorageAccountPermissions - Read or write operations are not allowed on the storage account {0}.\n\n * 400 StorageAccountIsDisabled - The storage account {0} is disabled.\n\n * 404 SourceDatabaseNotFound - Specified database does not exist.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription." + "description": "*** Error Responses: ***\n\n * 400 LedgerInvalidDigestStorageTargetUpdateRequest - The database ledger digest storage upload request does not exist or has no properties object.\n\n * 400 InvalidDigestStorageEndpoint - The specified digestStorageEndpoint is invalid. It must be an Azure blob storage endpoint.\n\n * 400 MalformedDigestStorageEndpoint - The specified digest storage endpoint is a malformed URI.\n\n * 400 InvalidLedgerDigestUploadsName - The ledger digest upload name is not supported. Please use the key name “current”.\n\n * 400 NoServerIdentity - No identity is configured for specified server. For information on how to configure an identity for the server see https://go.microsoft.com/fwlink/?linkid=2156804\n\n * 400 InsufficientStorageAccountPermissions - Read or write operations are not allowed on the storage account {0}.\n\n * 400 StorageAccountIsDisabled - The storage account {0} is disabled.\n\n * 400 AdalGenericError - The operation could not be completed because an Azure Active Directory error was encountered. The error message from Active Directory Authentication library (ADAL) is {0}.\n\n * 400 SubscriptionDoesNotHaveServer - Subscription {0} does not contain server {1}.\n\n * 400 InvalidStorageAccountName - The specified storage account is not valid or does not exist.\n\n * 404 SourceDatabaseNotFound - Specified database does not exist.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found" }, "202": { "description": "Disabling the ledger digest upload is in progress." } }, + "x-ms-long-running-operation": true, "x-ms-examples": { "Disables uploading ledger digests for a database": { "$ref": "./examples/LedgerDigestUploadsDisable.json" diff --git a/specification/subscription/resource-manager/Microsoft.Subscription/preview/2019-10-01-preview/subscriptions.json b/specification/subscription/resource-manager/Microsoft.Subscription/preview/2019-10-01-preview/subscriptions.json index bc23df26ea49..e7bc6f6df8bd 100644 --- a/specification/subscription/resource-manager/Microsoft.Subscription/preview/2019-10-01-preview/subscriptions.json +++ b/specification/subscription/resource-manager/Microsoft.Subscription/preview/2019-10-01-preview/subscriptions.json @@ -902,7 +902,7 @@ "in": "path", "required": true, "type": "string", - "description": "Alias Name" + "description": "Name for this subscription creation request also known as alias. Note that this is not the same as subscription name and this doesn’t have any other lifecycle need beyond the request for subscription creation." } }, "security": [ diff --git a/specification/subscription/resource-manager/Microsoft.Subscription/stable/2020-09-01/subscriptions.json b/specification/subscription/resource-manager/Microsoft.Subscription/stable/2020-09-01/subscriptions.json index 10aa6a32f048..12ca7c2b0664 100644 --- a/specification/subscription/resource-manager/Microsoft.Subscription/stable/2020-09-01/subscriptions.json +++ b/specification/subscription/resource-manager/Microsoft.Subscription/stable/2020-09-01/subscriptions.json @@ -566,7 +566,7 @@ "in": "path", "required": true, "type": "string", - "description": "Alias Name" + "description": "Name for this subscription creation request also known as alias. Note that this is not the same as subscription name and this doesn’t have any other lifecycle need beyond the request for subscription creation." } }, "security": [ diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/artifacts.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/artifacts.json index ab2e1da22643..9ed4fe5f65b0 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/artifacts.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/artifacts.json @@ -2649,209 +2649,6 @@ } } }, - "/kqlScripts": { - "get": { - "tags": [ - "kqlScripts" - ], - "operationId": "KqlScripts_GetAll", - "description": "Get all KQL scripts", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK.", - "schema": { - "$ref": "#/definitions/KqlScripts_ResourceCollectionResponse" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/workspace.json#/definitions/ErrorContract" - } - } - }, - "x-ms-examples": { - "KqlScripts_GetAll": { - "$ref": "./examples/KqlScripts_GetAll.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/kqlScripts/{kqlScriptName}": { - "put": { - "tags": [ - "kqlScripts" - ], - "operationId": "KqlScript_CreateOrUpdate", - "description": "Creates or updates a KQL Script", - "parameters": [ - { - "$ref": "#/parameters/KqlScriptName" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "name": "kqlScript", - "description": "KQL script", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/KqlScriptResource" - } - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/KqlScriptResource" - } - }, - "202": { - "description": "Accepted" - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/workspace.json#/definitions/ErrorContract" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "KqlScript_CreateOrUpdate": { - "$ref": "./examples/KqlScript_CreateOrUpdate.json" - } - } - }, - "get": { - "tags": [ - "kqlScripts" - ], - "operationId": "KqlScript_GetByName", - "description": "Get KQL script by name", - "parameters": [ - { - "$ref": "#/parameters/KqlScriptName" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/KqlScriptResource" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../common/v1/types.json#/definitions/ErrorContract" - } - } - }, - "x-ms-examples": { - "KqlScript_GetByName": { - "$ref": "./examples/KqlScript_GetByName.json" - } - } - }, - "delete": { - "tags": [ - "kqlScripts" - ], - "operationId": "KqlScript_DeleteByName", - "description": "Delete KQL script by name", - "parameters": [ - { - "$ref": "#/parameters/KqlScriptName" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK" - }, - "202": { - "description": "Accepted" - }, - "204": { - "description": "No Content" - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../common/v1/types.json#/definitions/ErrorContract" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "KqlScript_DeleteByName": { - "$ref": "./examples/KqlScript_DeleteByName.json" - } - } - } - }, - "/kqlScripts/{kqlScriptName}/rename": { - "post": { - "tags": [ - "kqlScripts" - ], - "operationId": "KqlScript_Rename", - "description": "Rename KQL script", - "parameters": [ - { - "$ref": "#/parameters/KqlScriptName" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "in": "body", - "name": "renameRequest", - "description": "Rename request", - "required": true, - "schema": { - "$ref": "#/definitions/ArtifactRenameRequest" - } - } - ], - "responses": { - "200": { - "description": "OK" - }, - "202": { - "description": "Accepted" - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "../../../../common/v1/types.json#/definitions/ErrorContract" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "KqlScript_Rename": { - "$ref": "./examples/KqlScript_Rename.json" - } - } - } - }, "/notebookOperationResults/{operationId}": { "get": { "tags": [ @@ -5095,66 +4892,6 @@ "maxLength": 260 } } - }, - "KqlScripts_ResourceCollectionResponse": { - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/KqlScriptResource" - } - }, - "nextLink": { - "type": "string" - } - } - }, - "KqlScriptResource": { - "properties": { - "id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "type": { - "type": "string" - }, - "properties": { - "$ref": "#/definitions/KqlScript", - "description": "Properties of sql script." - } - } - }, - "KqlScript": { - "properties": { - "content": { - "properties": { - "query": { - "type": "string" - }, - "metadata": { - "type": "object", - "properties": { - "language": { - "type": "string" - } - } - }, - "currentConnection": { - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string" - } - } - } - } - } - } } }, "parameters": { @@ -5322,14 +5059,6 @@ "in": "path", "x-ms-skip-url-encoding": true, "x-ms-parameter-location": "client" - }, - "KqlScriptName": { - "name": "kqlScriptName", - "in": "path", - "required": true, - "type": "string", - "description": "KQL script name", - "x-ms-parameter-location": "method" } } } diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/kqlScripts.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/kqlScripts.json new file mode 100644 index 000000000000..51e3fb510f19 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/kqlScripts.json @@ -0,0 +1,329 @@ +{ + "swagger": "2.0", + "info": { + "version": "2021-06-01-preview", + "title": "ArtifactsClient", + "x-ms-code-generation-settings": { + "useDateTimeOffset": true + } + }, + "x-ms-parameterized-host": { + "hostTemplate": "{endpoint}", + "useSchemePrefix": false, + "parameters": [ + { + "$ref": "#/parameters/Endpoint" + } + ] + }, + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/kqlScripts": { + "get": { + "tags": [ + "kqlScripts" + ], + "operationId": "KqlScripts_GetAll", + "description": "Get all KQL scripts", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/KqlScripts_ResourceCollectionResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/workspace.json#/definitions/ErrorContract" + } + } + }, + "x-ms-examples": { + "KqlScripts_GetAll": { + "$ref": "./examples/KqlScripts_GetAll.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/kqlScripts/{kqlScriptName}": { + "put": { + "tags": [ + "kqlScripts" + ], + "operationId": "KqlScript_CreateOrUpdate", + "description": "Creates or updates a KQL Script", + "parameters": [ + { + "$ref": "#/parameters/KqlScriptName" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "kqlScript", + "description": "KQL script", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/KqlScriptResource" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/KqlScriptResource" + } + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/workspace.json#/definitions/ErrorContract" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "KqlScript_CreateOrUpdate": { + "$ref": "./examples/KqlScript_CreateOrUpdate.json" + } + } + }, + "get": { + "tags": [ + "kqlScripts" + ], + "operationId": "KqlScript_GetByName", + "description": "Get KQL script by name", + "parameters": [ + { + "$ref": "#/parameters/KqlScriptName" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/KqlScriptResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../common/v1/types.json#/definitions/ErrorContract" + } + } + }, + "x-ms-examples": { + "KqlScript_GetByName": { + "$ref": "./examples/KqlScript_GetByName.json" + } + } + }, + "delete": { + "tags": [ + "kqlScripts" + ], + "operationId": "KqlScript_DeleteByName", + "description": "Delete KQL script by name", + "parameters": [ + { + "$ref": "#/parameters/KqlScriptName" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../common/v1/types.json#/definitions/ErrorContract" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "KqlScript_DeleteByName": { + "$ref": "./examples/KqlScript_DeleteByName.json" + } + } + } + }, + "/kqlScripts/{kqlScriptName}/rename": { + "post": { + "tags": [ + "kqlScripts" + ], + "operationId": "KqlScript_Rename", + "description": "Rename KQL script", + "parameters": [ + { + "$ref": "#/parameters/KqlScriptName" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "renameRequest", + "description": "Rename request", + "required": true, + "schema": { + "$ref": "./artifacts.json#/definitions/ArtifactRenameRequest" + } + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "../../../../common/v1/types.json#/definitions/ErrorContract" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "KqlScript_Rename": { + "$ref": "./examples/KqlScript_Rename.json" + } + } + } + } + }, + "definitions": { + "KqlScripts_ResourceCollectionResponse": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/KqlScriptResource" + } + }, + "nextLink": { + "type": "string" + } + } + }, + "KqlScriptResource": { + "properties": { + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "type": { + "type": "string" + }, + "properties": { + "$ref": "#/definitions/KqlScript", + "description": "Properties of sql script." + } + } + }, + "KqlScript": { + "properties": { + "content": { + "properties": { + "query": { + "type": "string" + }, + "metadata": { + "type": "object", + "properties": { + "language": { + "type": "string" + } + } + }, + "currentConnection": { + "properties": { + "name": { + "type": "string" + }, + "type": { + "type": "string" + } + } + } + } + } + } + } + }, + "parameters": { + "workspaceName": { + "name": "workspaceName", + "description": "The workspace name.", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The Synapse client API Version." + }, + "Endpoint": { + "name": "endpoint", + "description": "The workspace development endpoint, for example https://myworkspace.dev.azuresynapse.net.", + "required": true, + "type": "string", + "in": "path", + "x-ms-skip-url-encoding": true, + "x-ms-parameter-location": "client" + }, + "KqlScriptName": { + "name": "kqlScriptName", + "in": "path", + "required": true, + "type": "string", + "description": "KQL script name", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/synapse/data-plane/readme.go.md b/specification/synapse/data-plane/readme.go.md index 0e4fc0b59ddb..e59e46a56129 100644 --- a/specification/synapse/data-plane/readme.go.md +++ b/specification/synapse/data-plane/readme.go.md @@ -40,6 +40,16 @@ namespace: artifacts output-folder: $(go-sdk-folder)/services/preview/synapse/2019-06-01-preview/$(namespace) ``` +### Tag: package-artifacts-2021-06-01-preview and go + +These settings apply only when `--tag=package-artifacts-2021-06-01-preview --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-artifacts-2021-06-01-preview' && $(go) +namespace: artifacts +output-folder: $(go-sdk-folder)/services/preview/synapse/2021-06-01-preview/$(namespace) +``` + ### Tag: package-access-control-2020-02-01-preview and go These settings apply only when `--tag=package-access-control-2020-02-01-preview --go` is specified on the command line. @@ -78,4 +88,4 @@ Please also specify `--go-sdk-folder=floor 100" - }, - { - "searchString": "sensor on floor 0", - "highlightedSearchString": "sensor on floor 0" - }, - { - "searchString": "sensor on floor 1", - "highlightedSearchString": "sensor on floor 1" - } - ] - } - } - } -} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/ModelSettingsGet.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/ModelSettingsGet.json deleted file mode 100644 index 33be629b0ae6..000000000000 --- a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/ModelSettingsGet.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "parameters": { - "api-version": "2018-11-01-preview", - "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com" - }, - "responses": { - "200": { - "body": { - "modelSettings": { - "name": "DefaultModel", - "timeSeriesIdProperties": [ - { - "name": "DeviceId", - "type": "String" - } - ], - "defaultTypeId": "5AB70D71-A8CD-410E-B70D-6F04AB9C132C" - } - } - } - } -} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/ModelSettingsUpdateName.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/ModelSettingsUpdateName.json deleted file mode 100644 index a293f2d67e83..000000000000 --- a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/ModelSettingsUpdateName.json +++ /dev/null @@ -1,25 +0,0 @@ -{ - "parameters": { - "api-version": "2018-11-01-preview", - "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", - "parameters": { - "name": "Thermostats" - } - }, - "responses": { - "200": { - "body": { - "modelSettings": { - "name": "Thermostats", - "timeSeriesIdProperties": [ - { - "name": "DeviceId", - "type": "String" - } - ], - "defaultTypeId": "5AB70D71-A8CD-410E-B70D-6F04AB9C132C" - } - } - } - } -} 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 deleted file mode 100644 index 927530c2be95..000000000000 --- a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/QueryAggregateSeriesPage1.json +++ /dev/null @@ -1,61 +0,0 @@ -{ - "parameters": { - "api-version": "2018-11-01-preview", - "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", - "parameters": { - "aggregateSeries": { - "timeSeriesId": [ - "006dfc2d-0324-4937-998c-d16f3b4f1952", - "T1" - ], - "searchSpan": { - "from": "2016-08-01T00:00:00Z", - "to": "2016-08-01T00:16:50Z" - }, - "interval": "PT1M", - "inlineVariables": { - "Count": { - "kind": "aggregate", - "filter": null, - "aggregation": { - "tsx": "count()" - } - }, - "MinTemperature": { - "kind": "numeric", - "value": { - "tsx": "$event.Temperature" - }, - "filter": null, - "aggregation": { - "tsx": "min($value)" - } - }, - "MaxTemperature": { - "kind": "numeric", - "value": { - "tsx": "$event.Temperature" - }, - "filter": null, - "aggregation": { - "tsx": "max($value)" - } - } - }, - "projectedVariables": [ - "Count", - "MinTemperature", - "MaxTemperature" - ] - } - } - }, - "responses": { - "200": { - "body": { - "progress": 50.0, - "continuationToken": "aXsic2tpcCI6MTAwMCwidGFrZSI6MTAwMH0=" - } - } - } -} 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 deleted file mode 100644 index 9c0424d1ada5..000000000000 --- a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/QueryAggregateSeriesPage2.json +++ /dev/null @@ -1,144 +0,0 @@ -{ - "parameters": { - "api-version": "2018-11-01-preview", - "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", - "continuationToken": "aXsic2tpcCI6MTAwMCwidGFrZSI6MTAwMH0=", - "parameters": { - "aggregateSeries": { - "timeSeriesId": [ - "006dfc2d-0324-4937-998c-d16f3b4f1952", - "T1" - ], - "searchSpan": { - "from": "2016-08-01T00:00:00Z", - "to": "2016-08-01T00:16:50Z" - }, - "interval": "PT1M", - "inlineVariables": { - "Count": { - "kind": "aggregate", - "filter": null, - "aggregation": { - "tsx": "count()" - } - }, - "MinTemperature": { - "kind": "numeric", - "value": { - "tsx": "$event.Temperature" - }, - "filter": null, - "aggregation": { - "tsx": "min($value)" - } - }, - "MaxTemperature": { - "kind": "numeric", - "value": { - "tsx": "$event.Temperature" - }, - "filter": null, - "aggregation": { - "tsx": "max($value)" - } - } - }, - "projectedVariables": [ - "Count", - "MinTemperature", - "MaxTemperature" - ] - } - } - }, - "responses": { - "200": { - "body": { - "timestamps": [ - "2016-08-01T00:00:00Z", - "2016-08-01T00:01:00Z", - "2016-08-01T00:02:00Z", - "2016-08-01T00:03:00Z", - "2016-08-01T00:04:00Z", - "2016-08-01T00:05:00Z", - "2016-08-01T00:06:00Z", - "2016-08-01T00:07:00Z", - "2016-08-01T00:08:00Z", - "2016-08-01T00:09:00Z", - "2016-08-01T00:10:00Z" - ], - "properties": [ - { - "name": "Count", - "type": "Long", - "values": [ - 50, - 60, - 60, - 60, - 60, - 60, - 60, - 60, - 60, - 60, - null - ] - }, - { - "name": "AverageTemperature", - "type": "Double", - "values": [ - 71.25, - 85.0, - 82.5, - 80.0, - 89.166666666666671, - 75.0, - 90.0, - 75.833333333333329, - 85.0, - 82.5, - null - ] - }, - { - "name": "MinTemperature", - "type": "Double", - "values": [ - 65.125, - 77.625, - 65.125, - 72.625, - 65.125, - 67.625, - 82.625, - 65.125, - 77.625, - 65.125, - null - ] - }, - { - "name": "MaxTemperature", - "type": "Double", - "values": [ - 77.375, - 92.375, - 99.875, - 87.375, - 99.875, - 82.375, - 97.375, - 99.875, - 92.375, - 99.875, - null - ] - } - ], - "progress": 100.0 - } - } - } -} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/QueryAggregateSeriesWithCategoricalInterpolatedVariable.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/QueryAggregateSeriesWithCategoricalInterpolatedVariable.json deleted file mode 100644 index 662161648bff..000000000000 --- a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/QueryAggregateSeriesWithCategoricalInterpolatedVariable.json +++ /dev/null @@ -1,250 +0,0 @@ -{ - "parameters": { - "api-version": "2018-11-01-preview", - "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", - "continuationToken": "aXsic2tpcCI6MTAwMCwidGFrZSI6MTAwMH0=", - "parameters": { - "aggregateSeries": { - "searchSpan": { - "from": "2019-10-10T23:41:04.021Z", - "to": "2019-10-10T23:42:22.846Z" - }, - "timeSeriesId": [ - "Sensor_58" - ], - "interval": "PT2S", - "inlineVariables": { - "Status_String": { - "kind": "categorical", - "value": { - "tsx": "$event.[Status].String" - }, - "interpolation": { - "kind": "Step", - "boundary": { - "span": "PT5S" - } - }, - "categories": [ - { - "label": "Good", - "values": [ - "Good", - "Very Good", - "Excellent" - ] - }, - { - "label": "Bad", - "values": [ - "Bad", - "OK" - ] - }, - { - "label": "Other", - "values": [ - "Other" - ] - } - ], - "defaultCategory": { - "label": "Unknown" - } - }, - "Status_Long": { - "kind": "categorical", - "value": { - "tsx": "tolong($event.[Status].Double)" - }, - "interpolation": { - "kind": "Step", - "boundary": { - "span": "PT5S" - } - }, - "categories": [ - { - "label": "Good", - "values": [ - 0, - 1, - 2 - ] - }, - { - "label": "Bad", - "values": [ - 3, - 4 - ] - }, - { - "label": "Other", - "values": [ - 5 - ] - } - ], - "defaultCategory": { - "label": "Unknown" - } - } - }, - "projectedVariables": [ - "Status_String", - "Status_Long" - ] - } - } - }, - "responses": { - "200": { - "body": { - "timestamps": [ - "2019-10-10T23:41:04Z", - "2019-10-10T23:41:06Z", - "2019-10-10T23:41:08Z", - "2019-10-10T23:41:10Z", - "2019-10-10T23:41:12Z", - "2019-10-10T23:41:14Z", - "2019-10-10T23:41:16Z", - "2019-10-10T23:41:18Z", - "2019-10-10T23:41:20Z", - "2019-10-10T23:41:22Z" - ], - "properties": [ - { - "values": [ - 0.203, - 0.141, - 0.268, - 0.398, - 0.402, - 0.047, - 0.1245, - 0.75, - 0.206, - 0.2635 - ], - "name": "Status_String[Good]", - "type": "Double" - }, - { - "values": [ - 0.266, - 0.1955, - 0.242, - 0.148, - 0.25, - 0.055, - 0.6295, - 0.109, - 0.41, - 0.2125 - ], - "name": "Status_String[Bad]", - "type": "Double" - }, - { - "values": [ - 0.5205, - 0.6635, - 0.49, - 0.454, - 0.348, - 0.898, - 0.246, - 0.141, - 0.384, - 0.524 - ], - "name": "Status_String[Other]", - "type": "Double" - }, - { - "values": [ - 0.0, - 0.0, - 0.0, - 0.0, - 0.0, - 0.0, - 0.0, - 0.0, - 0.0, - 0.0 - ], - "name": "Status_String[Unknown]", - "type": "Double" - }, - { - "values": [ - 0.203, - 0.141, - 0.268, - 0.398, - 0.402, - 0.047, - 0.1245, - 0.75, - 0.206, - 0.2635 - ], - "name": "Status_Long[Good]", - "type": "Double" - }, - { - "values": [ - 0.266, - 0.1955, - 0.242, - 0.148, - 0.25, - 0.055, - 0.6295, - 0.109, - 0.41, - 0.2125 - ], - "name": "Status_Long[Bad]", - "type": "Double" - }, - { - "values": [ - 0.5205, - 0.6635, - 0.49, - 0.454, - 0.348, - 0.898, - 0.246, - 0.141, - 0.384, - 0.524 - ], - "name": "Status_Long[Other]", - "type": "Double" - }, - { - "values": [ - 0.0, - 0.0, - 0.0, - 0.0, - 0.0, - 0.0, - 0.0, - 0.0, - 0.0, - 0.0 - ], - "name": "Status_Long[Unknown]", - "type": "Double" - } - ], - "progress": 100.0 - } - } - } -} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/QueryAggregateSeriesWithCategoricalVariable.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/QueryAggregateSeriesWithCategoricalVariable.json deleted file mode 100644 index 3da48c7f188f..000000000000 --- a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/QueryAggregateSeriesWithCategoricalVariable.json +++ /dev/null @@ -1,238 +0,0 @@ -{ - "parameters": { - "api-version": "2018-11-01-preview", - "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", - "continuationToken": "aXsic2tpcCI6MTAwMCwidGFrZSI6MTAwMH0=", - "parameters": { - "aggregateSeries": { - "searchSpan": { - "from": "2019-10-10T23:42:00.000Z", - "to": "2019-10-10T23:42:20.000Z" - }, - "timeSeriesId": [ - "Sensor_58" - ], - "interval": "PT2S", - "inlineVariables": { - "Status_String": { - "kind": "categorical", - "value": { - "tsx": "$event.[Status].String" - }, - "categories": [ - { - "label": "Good", - "values": [ - "Good", - "Very Good", - "Excellent" - ] - }, - { - "label": "Bad", - "values": [ - "Bad", - "OK" - ] - }, - { - "label": "Other", - "values": [ - "Other" - ] - } - ], - "defaultCategory": { - "label": "Unknown" - } - }, - "Status_Long": { - "kind": "categorical", - "value": { - "tsx": "tolong($event.[Status].Double)" - }, - "categories": [ - { - "label": "Good", - "values": [ - 0, - 1, - 2 - ] - }, - { - "label": "Bad", - "values": [ - 3, - 4 - ] - }, - { - "label": "Other", - "values": [ - 5 - ] - } - ], - "defaultCategory": { - "label": "Unknown" - } - } - }, - "projectedVariables": [ - "Status_String", - "Status_Long" - ] - } - } - }, - "responses": { - "200": { - "body": { - "timestamps": [ - "2019-10-10T23:42:00Z", - "2019-10-10T23:42:02Z", - "2019-10-10T23:42:04Z", - "2019-10-10T23:42:06Z", - "2019-10-10T23:42:08Z", - "2019-10-10T23:42:10Z", - "2019-10-10T23:42:12Z", - "2019-10-10T23:42:14Z", - "2019-10-10T23:42:16Z", - "2019-10-10T23:42:18Z" - ], - "properties": [ - { - "values": [ - 5, - 8, - 4, - 6, - 9, - 8, - 3, - 6, - 5, - 8 - ], - "name": "Status_String[Good]", - "type": "Long" - }, - { - "values": [ - 4, - 3, - 3, - 5, - 5, - 3, - 9, - 7, - 7, - 7 - ], - "name": "Status_String[Bad]", - "type": "Long" - }, - { - "values": [ - 11, - 9, - 13, - 9, - 6, - 9, - 8, - 7, - 8, - 5 - ], - "name": "Status_String[Other]", - "type": "Long" - }, - { - "values": [ - 0, - 0, - 0, - 0, - 0, - 0, - 0, - 0, - 0, - 0 - ], - "name": "Status_String[Unknown]", - "type": "Long" - }, - { - "values": [ - 5, - 8, - 4, - 6, - 9, - 8, - 3, - 6, - 5, - 8 - ], - "name": "Status_Long[Good]", - "type": "Long" - }, - { - "values": [ - 4, - 3, - 3, - 5, - 5, - 3, - 9, - 7, - 7, - 7 - ], - "name": "Status_Long[Bad]", - "type": "Long" - }, - { - "values": [ - 11, - 9, - 13, - 9, - 6, - 9, - 8, - 7, - 8, - 5 - ], - "name": "Status_Long[Other]", - "type": "Long" - }, - { - "values": [ - 0, - 0, - 0, - 0, - 0, - 0, - 0, - 0, - 0, - 0 - ], - "name": "Status_Long[Unknown]", - "type": "Long" - } - ], - "progress": 100.0 - } - } - } -} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/QueryAggregateSeriesWithSampleInterpolation.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/QueryAggregateSeriesWithSampleInterpolation.json deleted file mode 100644 index 907d9093d875..000000000000 --- a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/QueryAggregateSeriesWithSampleInterpolation.json +++ /dev/null @@ -1,114 +0,0 @@ -{ - "parameters": { - "api-version": "2018-11-01-preview", - "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", - "continuationToken": "aXsic2tpcCI6MTAwMCwidGFrZSI6MTAwMH0=", - "parameters": { - "aggregateSeries": { - "timeSeriesId": [ - "006dfc2d-0324-4937-998c-d16f3b4f1952", - "T1" - ], - "searchSpan": { - "from": "2016-08-01T00:00:00Z", - "to": "2016-08-01T00:16:50Z" - }, - "interval": "PT1M", - "inlineVariables": { - "LinearSampleInterpolation": { - "kind": "numeric", - "value": { - "tsx": "$event.Temperature" - }, - "filter": null, - "interpolation": { - "kind": "Linear", - "boundary": { - "span": "P1D" - } - }, - "aggregation": { - "tsx": "left($value)" - } - }, - "StepSampleInterpolation": { - "kind": "numeric", - "value": { - "tsx": "$event.Temperature" - }, - "filter": null, - "interpolation": { - "kind": "Step", - "boundary": { - "span": "P1D" - } - }, - "aggregation": { - "tsx": "left($value)" - } - } - }, - "projectedVariables": [ - "LinearSampleInterpolation", - "StepSampleInterpolation" - ] - } - } - }, - "responses": { - "200": { - "body": { - "timestamps": [ - "2016-08-01T00:00:00Z", - "2016-08-01T00:01:00Z", - "2016-08-01T00:02:00Z", - "2016-08-01T00:03:00Z", - "2016-08-01T00:04:00Z", - "2016-08-01T00:05:00Z", - "2016-08-01T00:06:00Z", - "2016-08-01T00:07:00Z", - "2016-08-01T00:08:00Z", - "2016-08-01T00:09:00Z", - "2016-08-01T00:10:00Z" - ], - "properties": [ - { - "name": "LinearSampleInterpolation", - "type": "Double", - "values": [ - 50.0, - 60.0, - 60.0, - 60.0, - 60.0, - 60.0, - 60.0, - 60.0, - 60.0, - 60.0, - 62.0 - ] - }, - { - "name": "StepSampleInterpolation", - "type": "Double", - "values": [ - 71.25, - 85.0, - 82.5, - 80.0, - 89.166666666666671, - 75.0, - 90.0, - 75.833333333333329, - 85.0, - 82.5, - 84.0 - ] - } - ], - "progress": 100.0 - } - } - } -} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/QueryGetEventsPage1.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/QueryGetEventsPage1.json deleted file mode 100644 index a67cee0911c6..000000000000 --- a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/QueryGetEventsPage1.json +++ /dev/null @@ -1,39 +0,0 @@ -{ - "parameters": { - "api-version": "2018-11-01-preview", - "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", - "parameters": { - "getEvents": { - "timeSeriesId": [ - "006dfc2d-0324-4937-998c-d16f3b4f1952", - "T1" - ], - "searchSpan": { - "from": "2016-08-01T00:00:00Z", - "to": "2016-08-01T00:16:50Z" - }, - "filter": { - "tsx": "($event.Value.Double != null) OR ($event.Status.String = 'Good')" - }, - "projectedProperties": [ - { - "name": "Building", - "type": "String" - }, - { - "name": "Temperature", - "type": "Double" - } - ] - } - } - }, - "responses": { - "200": { - "body": { - "progress": 50.0, - "continuationToken": "aXsic2tpcCI6MTAwMCwidGFrZSI6MTAwMH0=" - } - } - } -} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/QueryGetEventsPage2.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/QueryGetEventsPage2.json deleted file mode 100644 index 482e6a171bbf..000000000000 --- a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/QueryGetEventsPage2.json +++ /dev/null @@ -1,86 +0,0 @@ -{ - "parameters": { - "api-version": "2018-11-01-preview", - "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", - "continuationToken": "aXsic2tpcCI6MTAwMCwidGFrZSI6MTAwMH0=", - "parameters": { - "getEvents": { - "timeSeriesId": [ - "006dfc2d-0324-4937-998c-d16f3b4f1952", - "T1" - ], - "searchSpan": { - "from": "2016-08-01T00:00:00Z", - "to": "2016-08-01T00:16:50Z" - }, - "filter": { - "tsx": "($event.Value.Double != null) OR ($event.Status.String = 'Good')" - }, - "projectedProperties": [ - { - "name": "Building", - "type": "String" - }, - { - "name": "Temperature", - "type": "Double" - } - ] - } - } - }, - "responses": { - "200": { - "body": { - "timestamps": [ - "2016-08-01T00:00:10Z", - "2016-08-01T00:00:11Z", - "2016-08-01T00:00:12Z", - "2016-08-01T00:00:13Z", - "2016-08-01T00:00:14Z", - "2016-08-01T00:00:15Z", - "2016-08-01T00:00:16Z", - "2016-08-01T00:00:17Z", - "2016-08-01T00:00:18Z", - "2016-08-01T00:00:19Z" - ], - "properties": [ - { - "name": "Building", - "type": "String", - "values": [ - "Millenium", - "Millenium", - "Millenium", - "Millenium", - "Millenium", - "Millenium", - "Millenium", - "Millenium", - "Millenium", - "Millenium" - ] - }, - { - "name": "Temperature", - "type": "Double", - "values": [ - 65.125, - 65.375, - 65.625, - 65.875, - 66.125, - 66.375, - 66.625, - 66.875, - 67.125, - 67.375 - ] - } - ], - "progress": 50.0, - "continuationToken": "aXsic2tpcCI6MTAxYZwidGFrZSI6MTAwMH0=" - } - } - } -} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/QueryGetEventsPage3.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/QueryGetEventsPage3.json deleted file mode 100644 index 8a42d4e8087c..000000000000 --- a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/QueryGetEventsPage3.json +++ /dev/null @@ -1,59 +0,0 @@ -{ - "parameters": { - "api-version": "2018-11-01-preview", - "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", - "continuationToken": "aXsic2tpcCI6MTAxYZwidGFrZSI6MTAwMH0=", - "parameters": { - "getEvents": { - "timeSeriesId": [ - "006dfc2d-0324-4937-998c-d16f3b4f1952", - "T1" - ], - "searchSpan": { - "from": "2016-08-01T00:00:00Z", - "to": "2016-08-01T00:16:50Z" - }, - "filter": { - "tsx": "($event.Value.Double != null) OR ($event.Status.String = 'Good')" - }, - "projectedProperties": [ - { - "name": "Building", - "type": "String" - }, - { - "name": "Temperature", - "type": "Double" - } - ] - } - } - }, - "responses": { - "200": { - "body": { - "timestamps": [ - "2016-08-01T00:00:20Z" - ], - "properties": [ - { - "name": "Building", - "type": "String", - "values": [ - "Millenium" - ] - }, - { - "name": "Temperature", - "type": "Double", - "values": [ - 67.575 - ] - } - ], - "progress": 50.0, - "continuationToken": "aXsic2tpcCI6MTAbCDewidGFrZSI6MTAwMH0=" - } - } - } -} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/QueryGetEventsPage4.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/QueryGetEventsPage4.json deleted file mode 100644 index 1dc95e83faf2..000000000000 --- a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/QueryGetEventsPage4.json +++ /dev/null @@ -1,41 +0,0 @@ -{ - "parameters": { - "api-version": "2018-11-01-preview", - "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", - "continuationToken": "aXsic2tpcCI6MTAbCDewidGFrZSI6MTAwMH0=", - "parameters": { - "getEvents": { - "timeSeriesId": [ - "006dfc2d-0324-4937-998c-d16f3b4f1952", - "T1" - ], - "searchSpan": { - "from": "2016-08-01T00:00:00Z", - "to": "2016-08-01T00:16:50Z" - }, - "filter": { - "tsx": "($event.Value.Double != null) OR ($event.Status.String = 'Good')" - }, - "projectedProperties": [ - { - "name": "Building", - "type": "String" - }, - { - "name": "Temperature", - "type": "Double" - } - ] - } - } - }, - "responses": { - "200": { - "body": { - "timestamps": [], - "properties": [], - "progress": 100.0 - } - } - } -} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/QueryGetEventsWithTakePage1.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/QueryGetEventsWithTakePage1.json deleted file mode 100644 index 759c1a333a30..000000000000 --- a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/QueryGetEventsWithTakePage1.json +++ /dev/null @@ -1,40 +0,0 @@ -{ - "parameters": { - "api-version": "2018-11-01-preview", - "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", - "parameters": { - "getEvents": { - "timeSeriesId": [ - "006dfc2d-0324-4937-998c-d16f3b4f1952", - "T1" - ], - "searchSpan": { - "from": "2016-08-01T00:00:00Z", - "to": "2016-08-01T00:16:50Z" - }, - "filter": { - "tsx": "($event.Value.Double != null) OR ($event.Status.String = 'Good')" - }, - "projectedProperties": [ - { - "name": "Building", - "type": "String" - }, - { - "name": "Temperature", - "type": "Double" - } - ], - "take": 10 - } - } - }, - "responses": { - "200": { - "body": { - "progress": 50.0, - "continuationToken": "aXsic2tpcCI6MTAwMCwidGFrZSI6MTAwMH0=" - } - } - } -} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/QueryGetEventsWithTakePage2.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/QueryGetEventsWithTakePage2.json deleted file mode 100644 index 0ffea83b8f92..000000000000 --- a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/QueryGetEventsWithTakePage2.json +++ /dev/null @@ -1,86 +0,0 @@ -{ - "parameters": { - "api-version": "2018-11-01-preview", - "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", - "continuationToken": "aXsic2tpcCI6MTAwMCwidGFrZSI6MTAwMH0=", - "parameters": { - "getEvents": { - "timeSeriesId": [ - "006dfc2d-0324-4937-998c-d16f3b4f1952", - "T1" - ], - "searchSpan": { - "from": "2016-08-01T00:00:00Z", - "to": "2016-08-01T00:16:50Z" - }, - "filter": { - "tsx": "($event.Value.Double != null) OR ($event.Status.String = 'Good')" - }, - "projectedProperties": [ - { - "name": "Building", - "type": "String" - }, - { - "name": "Temperature", - "type": "Double" - } - ], - "take": 10 - } - } - }, - "responses": { - "200": { - "body": { - "timestamps": [ - "2016-08-01T00:00:10Z", - "2016-08-01T00:00:11Z", - "2016-08-01T00:00:12Z", - "2016-08-01T00:00:13Z", - "2016-08-01T00:00:14Z", - "2016-08-01T00:00:15Z", - "2016-08-01T00:00:16Z", - "2016-08-01T00:00:17Z", - "2016-08-01T00:00:18Z", - "2016-08-01T00:00:19Z" - ], - "properties": [ - { - "name": "Building", - "type": "String", - "values": [ - "Millenium", - "Millenium", - "Millenium", - "Millenium", - "Millenium", - "Millenium", - "Millenium", - "Millenium", - "Millenium", - "Millenium" - ] - }, - { - "name": "Temperature", - "type": "Double", - "values": [ - 65.125, - 65.375, - 65.625, - 65.875, - 66.125, - 66.375, - 66.625, - 66.875, - 67.125, - 67.375 - ] - } - ], - "progress": 100.0 - } - } - } -} 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 deleted file mode 100644 index 768d28807304..000000000000 --- a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/QueryGetSeriesPage1.json +++ /dev/null @@ -1,42 +0,0 @@ -{ - "parameters": { - "api-version": "2018-11-01-preview", - "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", - "parameters": { - "getSeries": { - "timeSeriesId": [ - "006dfc2d-0324-4937-998c-d16f3b4f1952", - "T1" - ], - "searchSpan": { - "from": "2016-08-01T00:00:00Z", - "to": "2016-08-01T00:16:50Z" - }, - "filter": null, - "inlineVariables": { - "temperatures": { - "kind": "numeric", - "value": { - "tsx": "$event.Temperature" - }, - "filter": null, - "aggregation": { - "tsx": "avg($value)" - } - } - }, - "projectedVariables": [ - "temperatures" - ] - } - } - }, - "responses": { - "200": { - "body": { - "progress": 50.0, - "continuationToken": "aXsic2tpcCI6MTAwMCwidGFrZSI6MTAwMH0=" - } - } - } -} 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 deleted file mode 100644 index d795bd8c745a..000000000000 --- a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/QueryGetSeriesPage2.json +++ /dev/null @@ -1,75 +0,0 @@ -{ - "parameters": { - "api-version": "2018-11-01-preview", - "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", - "continuationToken": "aXsic2tpcCI6MTAwMCwidGFrZSI6MTAwMH0=", - "parameters": { - "getSeries": { - "timeSeriesId": [ - "006dfc2d-0324-4937-998c-d16f3b4f1952", - "T1" - ], - "searchSpan": { - "from": "2016-08-01T00:00:00Z", - "to": "2016-08-01T00:16:50Z" - }, - "filter": null, - "inlineVariables": { - "temperatures": { - "kind": "numeric", - "value": { - "tsx": "$event.Temperature" - }, - "filter": null, - "aggregation": { - "tsx": "avg($value)" - } - } - }, - "projectedVariables": [ - "temperatures" - ] - } - } - }, - "responses": { - "200": { - "body": { - "timestamps": [ - "2016-08-01T00:00:10Z", - "2016-08-01T00:00:11Z", - "2016-08-01T00:00:12Z", - "2016-08-01T00:00:13Z", - "2016-08-01T00:00:14Z", - "2016-08-01T00:00:15Z", - "2016-08-01T00:00:16Z", - "2016-08-01T00:00:17Z", - "2016-08-01T00:00:18Z", - "2016-08-01T00:00:19Z", - "2016-08-01T00:00:20Z" - ], - "properties": [ - { - "name": "temperatures", - "type": "Double", - "values": [ - 65.125, - 65.375, - 65.625, - 65.875, - 66.125, - 66.375, - 66.625, - 66.875, - 67.125, - 67.375, - 67.625 - ] - } - ], - "progress": 50.0, - "continuationToken": "aXsic2tpcCI6MTAxYZwidGFrZSI6MTAwMH0=" - } - } - } -} 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 deleted file mode 100644 index a138be65021e..000000000000 --- a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/QueryGetSeriesPage3.json +++ /dev/null @@ -1,54 +0,0 @@ -{ - "parameters": { - "api-version": "2018-11-01-preview", - "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", - "continuationToken": "aXsic2tpcCI6MTAxYZwidGFrZSI6MTAwMH0=", - "parameters": { - "getSeries": { - "timeSeriesId": [ - "006dfc2d-0324-4937-998c-d16f3b4f1952", - "T1" - ], - "searchSpan": { - "from": "2016-08-01T00:00:00Z", - "to": "2016-08-01T00:16:50Z" - }, - "filter": null, - "inlineVariables": { - "temperatures": { - "kind": "numeric", - "value": { - "tsx": "$event.Temperature" - }, - "filter": null, - "aggregation": { - "tsx": "avg($value)" - } - } - }, - "projectedVariables": [ - "temperatures" - ] - } - } - }, - "responses": { - "200": { - "body": { - "timestamps": [ - "2016-08-01T00:00:21Z" - ], - "properties": [ - { - "name": "temperatures", - "type": "Double", - "values": [ - 67.825 - ] - } - ], - "progress": 100.0 - } - } - } -} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/QueryGetSeriesWithTakePage1.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/QueryGetSeriesWithTakePage1.json deleted file mode 100644 index 380fd2ad94d3..000000000000 --- a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/QueryGetSeriesWithTakePage1.json +++ /dev/null @@ -1,43 +0,0 @@ -{ - "parameters": { - "api-version": "2018-11-01-preview", - "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", - "parameters": { - "getSeries": { - "timeSeriesId": [ - "006dfc2d-0324-4937-998c-d16f3b4f1952", - "T1" - ], - "searchSpan": { - "from": "2016-08-01T00:00:00Z", - "to": "2016-08-01T00:16:50Z" - }, - "filter": null, - "inlineVariables": { - "temperatures": { - "kind": "numeric", - "value": { - "tsx": "$event.Temperature" - }, - "filter": null, - "aggregation": { - "tsx": "avg($value)" - } - } - }, - "projectedVariables": [ - "temperatures" - ], - "take": 10 - } - } - }, - "responses": { - "200": { - "body": { - "progress": 50.0, - "continuationToken": "aXsic2tpcCI6MTAwMCwidGFrZSI6MTAwMH0=" - } - } - } -} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/QueryGetSeriesWithTakePage2.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/QueryGetSeriesWithTakePage2.json deleted file mode 100644 index 881ca18e3ef6..000000000000 --- a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/QueryGetSeriesWithTakePage2.json +++ /dev/null @@ -1,75 +0,0 @@ -{ - "parameters": { - "api-version": "2018-11-01-preview", - "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", - "continuationToken": "aXsic2tpcCI6MTAwMCwidGFrZSI6MTAwMH0=", - "parameters": { - "getSeries": { - "timeSeriesId": [ - "006dfc2d-0324-4937-998c-d16f3b4f1952", - "T1" - ], - "searchSpan": { - "from": "2016-08-01T00:00:00Z", - "to": "2016-08-01T00:16:50Z" - }, - "filter": null, - "inlineVariables": { - "temperatures": { - "kind": "numeric", - "value": { - "tsx": "$event.Temperature" - }, - "filter": null, - "aggregation": { - "tsx": "avg($value)" - } - } - }, - "projectedVariables": [ - "temperatures" - ], - "take": 10 - } - } - }, - "responses": { - "200": { - "body": { - "timestamps": [ - "2016-08-01T00:00:10Z", - "2016-08-01T00:00:11Z", - "2016-08-01T00:00:12Z", - "2016-08-01T00:00:13Z", - "2016-08-01T00:00:14Z", - "2016-08-01T00:00:15Z", - "2016-08-01T00:00:16Z", - "2016-08-01T00:00:17Z", - "2016-08-01T00:00:18Z", - "2016-08-01T00:00:19Z", - "2016-08-01T00:00:20Z" - ], - "properties": [ - { - "name": "temperatures", - "type": "Double", - "values": [ - 65.125, - 65.375, - 65.625, - 65.875, - 66.125, - 66.375, - 66.625, - 66.875, - 67.125, - 67.375, - 67.625 - ] - } - ], - "progress": 100.0 - } - } - } -} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/SearchInstancesDefault.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/SearchInstancesDefault.json deleted file mode 100644 index a1e12a720c82..000000000000 --- a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/SearchInstancesDefault.json +++ /dev/null @@ -1,48 +0,0 @@ -{ - "parameters": { - "api-version": "2018-11-01-preview", - "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", - "parameters": { - "searchString": "floor 100" - } - }, - "responses": { - "200": { - "body": { - "instances": { - "hits": [ - { - "timeSeriesId": [ - "Id1One", - "Id2One", - "1.0" - ], - "name": "instance1", - "typeId": "1be09af9-f089-4d6b-9f0b-48018b5f7393", - "hierarchyIds": [ - "1643004c-0a84-48a5-80e5-7688c5ae9295" - ], - "highlights": null - }, - { - "timeSeriesId": [ - "Id1Two", - "Id2Two", - "2.0" - ], - "name": "instance2", - "typeId": "1be09af9-f089-4d6b-9f0b-48018b5f7393", - "hierarchyIds": [ - "1643004c-0a84-48a5-80e5-7688c5ae9295" - ], - "highlights": null - } - ], - "hitCount": 2, - "continuationToken": null - }, - "hierarchyNodes": null - } - } - } -} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/SearchInstancesExpandHierarchiesOnly.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/SearchInstancesExpandHierarchiesOnly.json deleted file mode 100644 index c2443f272c75..000000000000 --- a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/SearchInstancesExpandHierarchiesOnly.json +++ /dev/null @@ -1,59 +0,0 @@ -{ - "parameters": { - "api-version": "2018-11-01-preview", - "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", - "parameters": { - "searchString": "floor 100", - "path": [ - "Location" - ], - "instances": null, - "hierarchies": { - "expand": { - "kind": "UntilChildren" - }, - "sort": { - "by": "Name" - }, - "pageSize": 2 - } - } - }, - "responses": { - "200": { - "body": { - "instances": { - "hits": [], - "hitCount": 0, - "continuationToken": null - }, - "hierarchyNodes": { - "hits": [ - { - "name": "California", - "cumulativeInstanceCount": 2, - "hierarchyNodes": { - "hits": [ - { - "name": "San Diego", - "cumulativeInstanceCount": 1, - "hierarchyNodes": null - }, - { - "name": "San Francisco", - "cumulativeInstanceCount": 1, - "hierarchyNodes": null - } - ], - "hitCount": 2, - "continuationToken": null - } - } - ], - "hitCount": 1, - "continuationToken": null - } - } - } - } -} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/SearchInstancesHierarchiesDefaultInputPage1.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/SearchInstancesHierarchiesDefaultInputPage1.json deleted file mode 100644 index a4053f07d4b6..000000000000 --- a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/SearchInstancesHierarchiesDefaultInputPage1.json +++ /dev/null @@ -1,106 +0,0 @@ -{ - "parameters": { - "api-version": "2018-11-01-preview", - "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", - "parameters": { - "searchString": "floor 100", - "path": null, - "instances": { - "recursive": true, - "sort": { - "by": "Rank" - }, - "highlights": true, - "pageSize": 1 - }, - "hierarchies": { - "expand": { - "kind": "UntilChildren" - }, - "sort": { - "by": "CumulativeInstanceCount" - }, - "pageSize": 1 - } - } - }, - "responses": { - "200": { - "body": { - "instances": { - "hits": [ - { - "timeSeriesId": [ - "Id1Two", - "Id2Two", - "2.0" - ], - "name": "instance2", - "typeId": "1be09af9-f089-4d6b-9f0b-48018b5f7393", - "hierarchyIds": [ - "1643004c-0a84-48a5-80e5-7688c5ae9295" - ], - "highlights": { - "timeSeriesId": [ - "Id1Two", - "Id2Two", - "2.0" - ], - "typeName": "DefaultType", - "name": "instance2", - "description": "floor 100", - "hierarchyIds": [ - "1643004c-0a84-48a5-80e5-7688c5ae9295" - ], - "hierarchyNames": [ - "Location" - ], - "instanceFieldNames": [ - "state", - "city" - ], - "instanceFieldValues": [ - "California", - "San Francisco" - ] - } - } - ], - "hitCount": 2, - "continuationToken": "c3sic2tpcCI6MiwidGFrZSI6MiwicmVxdWVzdEhhc2hDb2RlIjotNTE3MDUxOTg0LCJlbnZpcm9ubWVudElkIjoiYmY0M2YxMzMtM2Y2OC00ZWMwLWJjYjQtZmQ2NDUzMGU0MjU2In0=" - }, - "hierarchyNodes": { - "hits": [ - { - "name": "Location", - "cumulativeInstanceCount": 2, - "hierarchyNodes": { - "hits": [ - { - "name": "California", - "cumulativeInstanceCount": 2, - "hierarchyNodes": { - "hits": [ - { - "name": "San Francisco", - "cumulativeInstanceCount": 1, - "hierarchyNodes": null - } - ], - "hitCount": 2, - "continuationToken": "aHsic2tpcCI6MiwidGFrZSI6MiwicmVxdWVzdEhhc2hDb2RlIjotNzA4NTgyODU0LCJlbnZpcm9ubWVudElkIjoiYmY0M2YxMzMtM2Y2OC00ZWMwLWJjYjQtZmQ2NDUzMGU0MjU2In0=" - } - } - ], - "hitCount": 1, - "continuationToken": null - } - } - ], - "hitCount": 1, - "continuationToken": null - } - } - } - } -} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/SearchInstancesHierarchiesDefaultInputPage2.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/SearchInstancesHierarchiesDefaultInputPage2.json deleted file mode 100644 index 0557d31a3664..000000000000 --- a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/SearchInstancesHierarchiesDefaultInputPage2.json +++ /dev/null @@ -1,77 +0,0 @@ -{ - "parameters": { - "api-version": "2018-11-01-preview", - "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", - "continuationToken": "c3sic2tpcCI6MiwidGFrZSI6MiwicmVxdWVzdEhhc2hDb2RlIjotNTE3MDUxOTg0LCJlbnZpcm9ubWVudElkIjoiYmY0M2YxMzMtM2Y2OC00ZWMwLWJjYjQtZmQ2NDUzMGU0MjU2In0=", - "parameters": { - "searchString": "floor 100", - "path": null, - "instances": { - "recursive": true, - "sort": { - "by": "Rank" - }, - "highlights": true, - "pageSize": 1 - }, - "hierarchies": { - "expand": { - "kind": "UntilChildren" - }, - "sort": { - "by": "CumulativeInstanceCount" - }, - "pageSize": 1 - } - } - }, - "responses": { - "200": { - "body": { - "instances": { - "hits": [ - { - "timeSeriesId": [ - "Id1One", - "Id2One", - "1.0" - ], - "name": "instance1", - "typeId": "1be09af9-f089-4d6b-9f0b-48018b5f7393", - "hierarchyIds": [ - "1643004c-0a84-48a5-80e5-7688c5ae9295" - ], - "highlights": { - "timeSeriesId": [ - "Id1One", - "Id2One", - "1.0" - ], - "typeName": "DefaultType", - "name": "instance1", - "description": "floor 100", - "hierarchyIds": [ - "1643004c-0a84-48a5-80e5-7688c5ae9295" - ], - "hierarchyNames": [ - "Location" - ], - "instanceFieldNames": [ - "state", - "city" - ], - "instanceFieldValues": [ - "California", - "Los Angeles" - ] - } - } - ], - "hitCount": 2, - "continuationToken": null - }, - "hierarchyNodes": null - } - } - } -} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/SearchInstancesHierarchiesDefaultInputPage3.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/SearchInstancesHierarchiesDefaultInputPage3.json deleted file mode 100644 index f3aa7704c26c..000000000000 --- a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/SearchInstancesHierarchiesDefaultInputPage3.json +++ /dev/null @@ -1,66 +0,0 @@ -{ - "parameters": { - "api-version": "2018-11-01-preview", - "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", - "continuationToken": "aHsic2tpcCI6MiwidGFrZSI6MiwicmVxdWVzdEhhc2hDb2RlIjotNzA4NTgyODU0LCJlbnZpcm9ubWVudElkIjoiYmY0M2YxMzMtM2Y2OC00ZWMwLWJjYjQtZmQ2NDUzMGU0MjU2In0=", - "parameters": { - "searchString": "floor 100", - "path": null, - "instances": { - "recursive": true, - "sort": { - "by": "Rank" - }, - "highlights": true, - "pageSize": 1 - }, - "hierarchies": { - "expand": { - "kind": "UntilChildren" - }, - "sort": { - "by": "CumulativeInstanceCount" - }, - "pageSize": 1 - } - } - }, - "responses": { - "200": { - "body": { - "instances": null, - "hierarchyNodes": { - "hits": [ - { - "name": "Location", - "cumulativeInstanceCount": 2, - "hierarchyNodes": { - "hits": [ - { - "name": "California", - "cumulativeInstanceCount": 2, - "hierarchyNodes": { - "hits": [ - { - "name": "San Diego", - "cumulativeInstanceCount": 1, - "hierarchyNodes": null - } - ], - "hitCount": 2, - "continuationToken": "aHsic2tpcCI6MiwidGFrZSI6MiwicmVxdWVzdEhhc2hDb2RlIjotNzA4NTgyODU0LCJlbnZpcm9ubWVudElkIjoiYmY0M2YxMzMtM2Y2OC00ZWMwLWJjYjQtZmQ2NDUzMGU0MjU2In0=" - } - } - ], - "hitCount": 1, - "continuationToken": null - } - } - ], - "hitCount": 1, - "continuationToken": null - } - } - } - } -} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/SearchInstancesOneLevel.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/SearchInstancesOneLevel.json deleted file mode 100644 index f59e6e7f858f..000000000000 --- a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/SearchInstancesOneLevel.json +++ /dev/null @@ -1,49 +0,0 @@ -{ - "parameters": { - "api-version": "2018-11-01-preview", - "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", - "parameters": { - "searchString": "floor 100", - "path": null, - "instances": { - "recursive": false, - "sort": { - "by": "DisplayName" - }, - "highlights": false, - "pageSize": 2 - }, - "hierarchies": { - "expand": { - "kind": "OneLevel" - }, - "sort": { - "by": "Name" - }, - "pageSize": 2 - } - } - }, - "responses": { - "200": { - "body": { - "instances": { - "hits": [], - "hitCount": 0, - "continuationToken": null - }, - "hierarchyNodes": { - "hits": [ - { - "name": "Location", - "cumulativeInstanceCount": 2, - "hierarchyNodes": null - } - ], - "hitCount": 1, - "continuationToken": null - } - } - } - } -} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/SearchInstancesRecursive.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/SearchInstancesRecursive.json deleted file mode 100644 index 74732603fcbb..000000000000 --- a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/SearchInstancesRecursive.json +++ /dev/null @@ -1,58 +0,0 @@ -{ - "parameters": { - "api-version": "2018-11-01-preview", - "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", - "parameters": { - "searchString": "floor 100", - "path": null, - "instances": { - "recursive": true, - "sort": { - "by": "DisplayName" - }, - "highlights": false, - "pageSize": 2 - }, - "hierarchies": null - } - }, - "responses": { - "200": { - "body": { - "instances": { - "hits": [ - { - "timeSeriesId": [ - "Id1One", - "Id2One", - "1.0" - ], - "name": "instance1", - "typeId": "1be09af9-f089-4d6b-9f0b-48018b5f7393", - "hierarchyIds": [ - "1643004c-0a84-48a5-80e5-7688c5ae9295" - ], - "highlights": null - }, - { - "timeSeriesId": [ - "Id1Two", - "Id2Two", - "2.0" - ], - "name": "instance2", - "typeId": "1be09af9-f089-4d6b-9f0b-48018b5f7393", - "hierarchyIds": [ - "1643004c-0a84-48a5-80e5-7688c5ae9295" - ], - "highlights": null - } - ], - "hitCount": 2, - "continuationToken": null - }, - "hierarchyNodes": null - } - } - } -} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/SearchInstancesUntilChildren.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/SearchInstancesUntilChildren.json deleted file mode 100644 index 5f7b15f9c180..000000000000 --- a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/SearchInstancesUntilChildren.json +++ /dev/null @@ -1,66 +0,0 @@ -{ - "parameters": { - "api-version": "2018-11-01-preview", - "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", - "parameters": { - "searchString": "floor 100", - "path": [ - "Location" - ], - "instances": { - "recursive": false, - "sort": { - "by": "DisplayName" - }, - "highlights": false, - "pageSize": 2 - }, - "hierarchies": { - "expand": { - "kind": "UntilChildren" - }, - "sort": { - "by": "Name" - }, - "pageSize": 2 - } - } - }, - "responses": { - "200": { - "body": { - "instances": { - "hits": [], - "hitCount": 0, - "continuationToken": null - }, - "hierarchyNodes": { - "hits": [ - { - "name": "California", - "cumulativeInstanceCount": 2, - "hierarchyNodes": { - "hits": [ - { - "name": "San Diego", - "cumulativeInstanceCount": 1, - "hierarchyNodes": null - }, - { - "name": "San Francisco", - "cumulativeInstanceCount": 1, - "hierarchyNodes": null - } - ], - "hitCount": 2, - "continuationToken": null - } - } - ], - "hitCount": 1, - "continuationToken": null - } - } - } - } -} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/TypesBatchDeleteByIds.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/TypesBatchDeleteByIds.json deleted file mode 100644 index 06cffe01e03d..000000000000 --- a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/TypesBatchDeleteByIds.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "parameters": { - "api-version": "2018-11-01-preview", - "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", - "parameters": { - "delete": { - "typeIds": [ - "9250f816-faed-44c4-88e6-630e5eefa38b" - ] - } - } - }, - "responses": { - "200": { - "body": { - "delete": [ - null - ] - } - } - } -} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/TypesBatchDeleteByNames.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/TypesBatchDeleteByNames.json deleted file mode 100644 index 048590e0d8c2..000000000000 --- a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/TypesBatchDeleteByNames.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "parameters": { - "api-version": "2018-11-01-preview", - "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", - "parameters": { - "delete": { - "names": [ - "TemperatureSensor" - ] - } - } - }, - "responses": { - "200": { - "body": { - "delete": [ - null - ] - } - } - } -} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/TypesBatchGetByIds.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/TypesBatchGetByIds.json deleted file mode 100644 index 79708427f893..000000000000 --- a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/TypesBatchGetByIds.json +++ /dev/null @@ -1,60 +0,0 @@ -{ - "parameters": { - "api-version": "2018-11-01-preview", - "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", - "parameters": { - "get": { - "typeIds": [ - "1be09af9-f089-4d6b-9f0b-48018b5f7393", - "c1cb7a33-ed9b-4cf1-9958-f3162fed8ee8" - ], - "names": null - } - } - }, - "responses": { - "200": { - "body": { - "get": [ - { - "timeSeriesType": { - "id": "1be09af9-f089-4d6b-9f0b-48018b5f7393", - "name": "DefaultType", - "description": "Default type", - "variables": { - "EventCount": { - "kind": "aggregate", - "filter": null, - "aggregation": { - "tsx": "count()" - } - } - } - }, - "error": null - }, - { - "timeSeriesType": { - "id": "c1cb7a33-ed9b-4cf1-9958-f3162fed8ee8", - "name": "TemperatureSensor", - "description": "This is a temperature sensor.", - "variables": { - "AverageTemperature": { - "kind": "numeric", - "value": { - "tsx": "$event.Temperature.Double" - }, - "filter": null, - "aggregation": { - "tsx": "avg($value)" - } - } - } - }, - "error": null - } - ] - } - } - } -} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/TypesBatchGetByNames.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/TypesBatchGetByNames.json deleted file mode 100644 index 09ba068d160b..000000000000 --- a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/TypesBatchGetByNames.json +++ /dev/null @@ -1,59 +0,0 @@ -{ - "parameters": { - "api-version": "2018-11-01-preview", - "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", - "parameters": { - "get": { - "names": [ - "DefaultType", - "TemperatureSensor" - ] - } - } - }, - "responses": { - "200": { - "body": { - "get": [ - { - "timeSeriesType": { - "id": "1be09af9-f089-4d6b-9f0b-48018b5f7393", - "name": "DefaultType", - "description": "Default type", - "variables": { - "EventCount": { - "kind": "aggregate", - "filter": null, - "aggregation": { - "tsx": "count()" - } - } - } - }, - "error": null - }, - { - "timeSeriesType": { - "id": "c1cb7a33-ed9b-4cf1-9958-f3162fed8ee8", - "name": "TemperatureSensor", - "description": "This is a temperature sensor.", - "variables": { - "AverageTemperature": { - "kind": "numeric", - "value": { - "tsx": "$event.Temperature.Double" - }, - "filter": null, - "aggregation": { - "tsx": "avg($value)" - } - } - } - }, - "error": null - } - ] - } - } - } -} 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 deleted file mode 100644 index cfce86fd80b8..000000000000 --- a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/TypesBatchPut.json +++ /dev/null @@ -1,90 +0,0 @@ -{ - "parameters": { - "api-version": "2018-11-01-preview", - "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", - "parameters": { - "put": [ - { - "id": "1be09af9-f089-4d6b-9f0b-48018b5f7393", - "name": "DefaultType", - "description": "My Default type", - "variables": { - "EventCount": { - "kind": "aggregate", - "filter": null, - "aggregation": { - "tsx": "count()" - } - } - } - }, - { - "id": "c1cb7a33-ed9b-4cf1-9958-f3162fed8ee8", - "name": "OutdoorTemperatureSensor", - "description": "This is an outdoor temperature sensor.", - "variables": { - "AverageTemperature": { - "kind": "numeric", - "value": { - "tsx": "$event.Temperature.Double" - }, - "filter": { - "tsx": "$event.Mode.String = 'outdoor'" - }, - "aggregation": { - "tsx": "avg($value)" - } - } - } - } - ] - } - }, - "responses": { - "200": { - "body": { - "put": [ - { - "timeSeriesType": { - "id": "1be09af9-f089-4d6b-9f0b-48018b5f7393", - "name": "DefaultType", - "description": "My Default type", - "variables": { - "EventCount": { - "kind": "aggregate", - "filter": null, - "aggregation": { - "tsx": "count()" - } - } - } - }, - "error": null - }, - { - "timeSeriesType": { - "id": "c1cb7a33-ed9b-4cf1-9958-f3162fed8ee8", - "name": "OutdoorTemperatureSensor", - "description": "This is an outdoor temperature sensor.", - "variables": { - "AverageTemperature": { - "kind": "numeric", - "value": { - "tsx": "$event.Temperature.Double" - }, - "filter": { - "tsx": "$event.Mode.String = 'outdoor'" - }, - "aggregation": { - "tsx": "avg($value)" - } - } - } - }, - "error": null - } - ] - } - } - } -} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/TypesGetPage1.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/TypesGetPage1.json deleted file mode 100644 index 204a4d9cca64..000000000000 --- a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/TypesGetPage1.json +++ /dev/null @@ -1,29 +0,0 @@ -{ - "parameters": { - "api-version": "2018-11-01-preview", - "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com" - }, - "responses": { - "200": { - "body": { - "types": [ - { - "id": "1be09af9-f089-4d6b-9f0b-48018b5f7393", - "name": "DefaultType", - "description": "My Default type", - "variables": { - "EventCount": { - "kind": "aggregate", - "filter": null, - "aggregation": { - "tsx": "count()" - } - } - } - } - ], - "continuationToken": "aXsic2tpcCI6MTAwMCwidGFrZSI6MTAwMH0=" - } - } - } -} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/TypesGetPage2.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/TypesGetPage2.json deleted file mode 100644 index dacfd9da4740..000000000000 --- a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/TypesGetPage2.json +++ /dev/null @@ -1,32 +0,0 @@ -{ - "parameters": { - "api-version": "2018-11-01-preview", - "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", - "continuationToken": "aXsic2tpcCI6MTAwMCwidGFrZSI6MTAwMH0=" - }, - "responses": { - "200": { - "body": { - "types": [ - { - "id": "9b84e946-7b36-4aa0-9d26-71bf48cb2aff", - "name": "TurbineSensor", - "description": "Wind turbine sensor", - "variables": { - "Value": { - "kind": "numeric", - "value": { - "tsx": "$event.value.Double" - }, - "aggregation": { - "tsx": "avg($value)" - } - } - } - } - ], - "continuationToken": "aXsic2tpcCI6MTAwMCwidGFrASI6MTAwMH0=" - } - } - } -} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/TypesGetPage3.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/TypesGetPage3.json deleted file mode 100644 index 65be4bc46f2a..000000000000 --- a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/TypesGetPage3.json +++ /dev/null @@ -1,14 +0,0 @@ -{ - "parameters": { - "api-version": "2018-11-01-preview", - "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", - "continuationToken": "aXsic2tpcCI6MTAwMCwidGFrASI6MTAwMH0=" - }, - "responses": { - "200": { - "body": { - "types": [] - } - } - } -} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/WarmStoreAvailabilityGet.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/WarmStoreAvailabilityGet.json deleted file mode 100644 index fab7a099df2f..000000000000 --- a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/WarmStoreAvailabilityGet.json +++ /dev/null @@ -1,35 +0,0 @@ -{ - "parameters": { - "api-version": "2018-11-01-preview", - "storeType": "warmstore", - "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", - "clientRequestId": "A72703F6-C0B1-49EF-854A-59F1994F54E7", - "clientSessionId": "AlertCalculation_W7" - }, - "responses": { - "200": { - "headers": { - "x-ms-request-id": "0d59d156-2807-4952-87bb-0e074417dbfb" - }, - "body": { - "availability": { - "intervalSize": "PT1H", - "distribution": { - "2019-03-27T04:00:00Z": 432447, - "2019-03-27T05:00:00Z": 432340, - "2019-03-27T06:00:00Z": 432451, - "2019-03-27T07:00:00Z": 432436, - "2019-03-26T13:00:00Z": 386247, - "2019-03-27T00:00:00Z": 436968, - "2019-03-27T01:00:00Z": 432509, - "2019-03-27T02:00:00Z": 432487 - }, - "range": { - "from": "2019-03-14T06:38:27.153Z", - "to": "2019-03-27T03:57:11.697Z" - } - } - } - } - } -} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/WarmStoreEventSchemaGet.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/WarmStoreEventSchemaGet.json deleted file mode 100644 index 391a7637b12d..000000000000 --- a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/WarmStoreEventSchemaGet.json +++ /dev/null @@ -1,45 +0,0 @@ -{ - "parameters": { - "api-version": "2018-11-01-preview", - "storeType": "warmstore", - "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", - "parameters": { - "searchSpan": { - "from": "2018-08-01T00:00:00.000Z", - "to": "2018-08-31T00:00:00.000Z" - } - } - }, - "responses": { - "200": { - "body": { - "properties": [ - { - "name": "Building", - "type": "String" - }, - { - "name": "Room", - "type": "String" - }, - { - "name": "DeviceId", - "type": "Double" - }, - { - "name": "Temperature", - "type": "Double" - }, - { - "name": "Pressure", - "type": "Double" - }, - { - "name": "Status", - "type": "String" - } - ] - } - } - } -} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/WarmStoreQueryAggregateSeriesPage.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/WarmStoreQueryAggregateSeriesPage.json deleted file mode 100644 index 88518303ad1d..000000000000 --- a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/WarmStoreQueryAggregateSeriesPage.json +++ /dev/null @@ -1,144 +0,0 @@ -{ - "parameters": { - "api-version": "2018-11-01-preview", - "storeType": "warmstore", - "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", - "parameters": { - "aggregateSeries": { - "timeSeriesId": [ - "006dfc2d-0324-4937-998c-d16f3b4f1952", - "T1" - ], - "searchSpan": { - "from": "2016-08-01T00:00:00Z", - "to": "2016-08-01T00:16:50Z" - }, - "interval": "PT1M", - "inlineVariables": { - "Count": { - "kind": "aggregate", - "filter": null, - "aggregation": { - "tsx": "count()" - } - }, - "MinTemperature": { - "kind": "numeric", - "value": { - "tsx": "$event.Temperature" - }, - "filter": null, - "aggregation": { - "tsx": "min($value)" - } - }, - "MaxTemperature": { - "kind": "numeric", - "value": { - "tsx": "$event.Temperature" - }, - "filter": null, - "aggregation": { - "tsx": "max($value)" - } - } - }, - "projectedVariables": [ - "Count", - "MinTemperature", - "MaxTemperature" - ] - } - } - }, - "responses": { - "200": { - "body": { - "timestamps": [ - "2016-08-01T00:00:00Z", - "2016-08-01T00:01:00Z", - "2016-08-01T00:02:00Z", - "2016-08-01T00:03:00Z", - "2016-08-01T00:04:00Z", - "2016-08-01T00:05:00Z", - "2016-08-01T00:06:00Z", - "2016-08-01T00:07:00Z", - "2016-08-01T00:08:00Z", - "2016-08-01T00:09:00Z", - "2016-08-01T00:10:00Z" - ], - "properties": [ - { - "name": "Count", - "type": "Long", - "values": [ - 50, - 60, - 60, - 60, - 60, - 60, - 60, - 60, - 60, - 60, - null - ] - }, - { - "name": "AverageTemperature", - "type": "Double", - "values": [ - 71.25, - 85.0, - 82.5, - 80.0, - 89.166666666666671, - 75.0, - 90.0, - 75.833333333333329, - 85.0, - 82.5, - null - ] - }, - { - "name": "MinTemperature", - "type": "Double", - "values": [ - 65.125, - 77.625, - 65.125, - 72.625, - 65.125, - 67.625, - 82.625, - 65.125, - 77.625, - 65.125, - null - ] - }, - { - "name": "MaxTemperature", - "type": "Double", - "values": [ - 77.375, - 92.375, - 99.875, - 87.375, - 99.875, - 82.375, - 97.375, - 99.875, - 92.375, - 99.875, - null - ] - } - ], - "progress": 100.0 - } - } - } -} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/WarmStoreQueryGetEventsPage1.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/WarmStoreQueryGetEventsPage1.json deleted file mode 100644 index b24cbf93f2a9..000000000000 --- a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/WarmStoreQueryGetEventsPage1.json +++ /dev/null @@ -1,40 +0,0 @@ -{ - "parameters": { - "api-version": "2018-11-01-preview", - "storeType": "warmstore", - "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", - "parameters": { - "getEvents": { - "timeSeriesId": [ - "006dfc2d-0324-4937-998c-d16f3b4f1952", - "T1" - ], - "searchSpan": { - "from": "2016-08-01T00:00:00Z", - "to": "2016-08-01T00:16:50Z" - }, - "filter": { - "tsx": "($event.Value.Double != null) OR ($event.Status.String = 'Good')" - }, - "projectedProperties": [ - { - "name": "Building", - "type": "String" - }, - { - "name": "Temperature", - "type": "Double" - } - ] - } - } - }, - "responses": { - "200": { - "body": { - "progress": 50.0, - "continuationToken": "aXsic2tpcCI6MTAwMCwidGFrZSI6MTAwMH0=" - } - } - } -} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/WarmStoreQueryGetEventsPage2.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/WarmStoreQueryGetEventsPage2.json deleted file mode 100644 index 4059db5e0882..000000000000 --- a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/WarmStoreQueryGetEventsPage2.json +++ /dev/null @@ -1,87 +0,0 @@ -{ - "parameters": { - "api-version": "2018-11-01-preview", - "storeType": "warmstore", - "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", - "continuationToken": "aXsic2tpcCI6MTAwMCwidGFrZSI6MTAwMH0=", - "parameters": { - "getEvents": { - "timeSeriesId": [ - "006dfc2d-0324-4937-998c-d16f3b4f1952", - "T1" - ], - "searchSpan": { - "from": "2016-08-01T00:00:00Z", - "to": "2016-08-01T00:16:50Z" - }, - "filter": { - "tsx": "($event.Value.Double != null) OR ($event.Status.String = 'Good')" - }, - "projectedProperties": [ - { - "name": "Building", - "type": "String" - }, - { - "name": "Temperature", - "type": "Double" - } - ] - } - } - }, - "responses": { - "200": { - "body": { - "timestamps": [ - "2016-08-01T00:00:10Z", - "2016-08-01T00:00:11Z", - "2016-08-01T00:00:12Z", - "2016-08-01T00:00:13Z", - "2016-08-01T00:00:14Z", - "2016-08-01T00:00:15Z", - "2016-08-01T00:00:16Z", - "2016-08-01T00:00:17Z", - "2016-08-01T00:00:18Z", - "2016-08-01T00:00:19Z" - ], - "properties": [ - { - "name": "Building", - "type": "String", - "values": [ - "Millenium", - "Millenium", - "Millenium", - "Millenium", - "Millenium", - "Millenium", - "Millenium", - "Millenium", - "Millenium", - "Millenium" - ] - }, - { - "name": "Temperature", - "type": "Double", - "values": [ - 65.125, - 65.375, - 65.625, - 65.875, - 66.125, - 66.375, - 66.625, - 66.875, - 67.125, - 67.375 - ] - } - ], - "progress": 50.0, - "continuationToken": "aXsic2tpcCI6MTAxYZwidGFrZSI6MTAwMH0=" - } - } - } -} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/WarmStoreQueryGetEventsPage3.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/WarmStoreQueryGetEventsPage3.json deleted file mode 100644 index 09c3e5be2929..000000000000 --- a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/WarmStoreQueryGetEventsPage3.json +++ /dev/null @@ -1,60 +0,0 @@ -{ - "parameters": { - "api-version": "2018-11-01-preview", - "storeType": "warmstore", - "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", - "continuationToken": "aXsic2tpcCI6MTAxYZwidGFrZSI6MTAwMH0=", - "parameters": { - "getEvents": { - "timeSeriesId": [ - "006dfc2d-0324-4937-998c-d16f3b4f1952", - "T1" - ], - "searchSpan": { - "from": "2016-08-01T00:00:00Z", - "to": "2016-08-01T00:16:50Z" - }, - "filter": { - "tsx": "($event.Value.Double != null) OR ($event.Status.String = 'Good')" - }, - "projectedProperties": [ - { - "name": "Building", - "type": "String" - }, - { - "name": "Temperature", - "type": "Double" - } - ] - } - } - }, - "responses": { - "200": { - "body": { - "timestamps": [ - "2016-08-01T00:00:20Z" - ], - "properties": [ - { - "name": "Building", - "type": "String", - "values": [ - "Millenium" - ] - }, - { - "name": "Temperature", - "type": "Double", - "values": [ - 67.575 - ] - } - ], - "progress": 50.0, - "continuationToken": "aXsic2tpcCI6MTAbCDewidGFrZSI6MTAwMH0=" - } - } - } -} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/WarmStoreQueryGetEventsPage4.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/WarmStoreQueryGetEventsPage4.json deleted file mode 100644 index fc3e00c9c999..000000000000 --- a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/WarmStoreQueryGetEventsPage4.json +++ /dev/null @@ -1,42 +0,0 @@ -{ - "parameters": { - "api-version": "2018-11-01-preview", - "storeType": "warmstore", - "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", - "continuationToken": "aXsic2tpcCI6MTAbCDewidGFrZSI6MTAwMH0=", - "parameters": { - "getEvents": { - "timeSeriesId": [ - "006dfc2d-0324-4937-998c-d16f3b4f1952", - "T1" - ], - "searchSpan": { - "from": "2016-08-01T00:00:00Z", - "to": "2016-08-01T00:16:50Z" - }, - "filter": { - "tsx": "($event.Value.Double != null) OR ($event.Status.String = 'Good')" - }, - "projectedProperties": [ - { - "name": "Building", - "type": "String" - }, - { - "name": "Temperature", - "type": "Double" - } - ] - } - } - }, - "responses": { - "200": { - "body": { - "timestamps": [], - "properties": [], - "progress": 100.0 - } - } - } -} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/WarmStoreQueryGetSeriesPage1.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/WarmStoreQueryGetSeriesPage1.json deleted file mode 100644 index 5c719a880890..000000000000 --- a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/WarmStoreQueryGetSeriesPage1.json +++ /dev/null @@ -1,43 +0,0 @@ -{ - "parameters": { - "api-version": "2018-11-01-preview", - "storeType": "warmstore", - "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", - "parameters": { - "getSeries": { - "timeSeriesId": [ - "006dfc2d-0324-4937-998c-d16f3b4f1952", - "T1" - ], - "searchSpan": { - "from": "2016-08-01T00:00:00Z", - "to": "2016-08-01T00:16:50Z" - }, - "filter": null, - "inlineVariables": { - "temperatures": { - "kind": "numeric", - "value": { - "tsx": "$event.Temperature" - }, - "filter": null, - "aggregation": { - "tsx": "avg($value)" - } - } - }, - "projectedVariables": [ - "temperatures" - ] - } - } - }, - "responses": { - "200": { - "body": { - "progress": 50.0, - "continuationToken": "aXsic2tpcCI6MTAwMCwidGFrZSI6MTAwMH0=" - } - } - } -} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/WarmStoreQueryGetSeriesPage2.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/WarmStoreQueryGetSeriesPage2.json deleted file mode 100644 index 7f8c824cf022..000000000000 --- a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/WarmStoreQueryGetSeriesPage2.json +++ /dev/null @@ -1,76 +0,0 @@ -{ - "parameters": { - "api-version": "2018-11-01-preview", - "storeType": "warmstore", - "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", - "continuationToken": "aXsic2tpcCI6MTAwMCwidGFrZSI6MTAwMH0=", - "parameters": { - "getSeries": { - "timeSeriesId": [ - "006dfc2d-0324-4937-998c-d16f3b4f1952", - "T1" - ], - "searchSpan": { - "from": "2016-08-01T00:00:00Z", - "to": "2016-08-01T00:16:50Z" - }, - "filter": null, - "inlineVariables": { - "temperatures": { - "kind": "numeric", - "value": { - "tsx": "$event.Temperature" - }, - "filter": null, - "aggregation": { - "tsx": "avg($value)" - } - } - }, - "projectedVariables": [ - "temperatures" - ] - } - } - }, - "responses": { - "200": { - "body": { - "timestamps": [ - "2016-08-01T00:00:10Z", - "2016-08-01T00:00:11Z", - "2016-08-01T00:00:12Z", - "2016-08-01T00:00:13Z", - "2016-08-01T00:00:14Z", - "2016-08-01T00:00:15Z", - "2016-08-01T00:00:16Z", - "2016-08-01T00:00:17Z", - "2016-08-01T00:00:18Z", - "2016-08-01T00:00:19Z", - "2016-08-01T00:00:20Z" - ], - "properties": [ - { - "name": "temperatures", - "type": "Double", - "values": [ - 65.125, - 65.375, - 65.625, - 65.875, - 66.125, - 66.375, - 66.625, - 66.875, - 67.125, - 67.375, - 67.625 - ] - } - ], - "progress": 50.0, - "continuationToken": "aXsic2tpcCI6MTAxYZwidGFrZSI6MTAwMH0=" - } - } - } -} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/WarmStoreQueryGetSeriesPage3.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/WarmStoreQueryGetSeriesPage3.json deleted file mode 100644 index fb0e7a620456..000000000000 --- a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/WarmStoreQueryGetSeriesPage3.json +++ /dev/null @@ -1,55 +0,0 @@ -{ - "parameters": { - "api-version": "2018-11-01-preview", - "storeType": "warmstore", - "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", - "continuationToken": "aXsic2tpcCI6MTAxYZwidGFrZSI6MTAwMH0=", - "parameters": { - "getSeries": { - "timeSeriesId": [ - "006dfc2d-0324-4937-998c-d16f3b4f1952", - "T1" - ], - "searchSpan": { - "from": "2016-08-01T00:00:00Z", - "to": "2016-08-01T00:16:50Z" - }, - "filter": null, - "inlineVariables": { - "temperatures": { - "kind": "numeric", - "value": { - "tsx": "$event.Temperature" - }, - "filter": null, - "aggregation": { - "tsx": "avg($value)" - } - } - }, - "projectedVariables": [ - "temperatures" - ] - } - } - }, - "responses": { - "200": { - "body": { - "timestamps": [ - "2016-08-01T00:00:21Z" - ], - "properties": [ - { - "name": "temperatures", - "type": "Double", - "values": [ - 67.825 - ] - } - ], - "progress": 100.0 - } - } - } -} 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 deleted file mode 100644 index 20fdbb673801..000000000000 --- a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/timeseriesinsights.json +++ /dev/null @@ -1,2517 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "TimeSeriesInsightsClient", - "description": "Time Series Insights environment data plane client for Gen2 (Preview L1 SKU) environments.", - "version": "2018-11-01-preview" - }, - "x-ms-parameterized-host": { - "hostTemplate": "{environmentFqdn}", - "useSchemePrefix": true, - "positionInOperation": "first", - "parameters": [ - { - "$ref": "#/parameters/EnvironmentFqdn" - } - ] - }, - "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": { - "/availability": { - "get": { - "tags": [ - "Query" - ], - "operationId": "Query_GetAvailability", - "description": "Returns the time range and distribution of event count over the event timestamp ($ts). This API can be used to provide landing experience of navigating to the environment.", - "x-ms-examples": { - "AvailabilityGet": { - "$ref": "./examples/AvailabilityGet.json" - }, - "ColdStoreAvailabilityGet": { - "$ref": "./examples/ColdStoreAvailabilityGet.json" - }, - "WarmStoreAvailabilityGet": { - "$ref": "./examples/WarmStoreAvailabilityGet.json" - }, - "AvailabilityGetEmpty": { - "$ref": "./examples/AvailabilityGetEmpty.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/StoreType" - }, - { - "$ref": "#/parameters/ClientRequestId" - }, - { - "$ref": "#/parameters/ClientSessionId" - } - ], - "responses": { - "200": { - "description": "Successful operation.", - "schema": { - "$ref": "#/definitions/AvailabilityResponse" - }, - "headers": { - "x-ms-request-id": { - "x-ms-client-name": "serverRequestId", - "type": "string", - "description": "Server-generated request ID. Can be used to contact support to investigate a request." - } - } - }, - "default": { - "description": "Unexpected error.", - "schema": { - "$ref": "#/definitions/TsiError" - }, - "headers": { - "x-ms-request-id": { - "x-ms-client-name": "serverRequestId", - "type": "string", - "description": "Server-generated request ID. Can be used to contact support to investigate a request." - } - } - } - } - } - }, - "/eventSchema": { - "post": { - "tags": [ - "Query" - ], - "operationId": "Query_GetEventSchema", - "description": "Returns environment event schema for a given search span. Event schema is a set of property definitions. Event schema may not be contain all persisted properties when there are too many properties.", - "x-ms-examples": { - "EventSchemaGet": { - "$ref": "./examples/EventSchemaGet.json" - }, - "EventSchemaGetEmpty": { - "$ref": "./examples/EventSchemaGetEmpty.json" - }, - "ColdStoreEventSchemaGet": { - "$ref": "./examples/ColdStoreEventSchemaGet.json" - }, - "WarmStoreEventSchemaGet": { - "$ref": "./examples/WarmStoreEventSchemaGet.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/StoreType" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/GetEventSchemaRequest" - }, - "description": "Parameters to get event schema." - }, - { - "$ref": "#/parameters/ClientRequestId" - }, - { - "$ref": "#/parameters/ClientSessionId" - } - ], - "responses": { - "200": { - "description": "Successful operation.", - "schema": { - "$ref": "#/definitions/EventSchema" - }, - "headers": { - "x-ms-request-id": { - "x-ms-client-name": "serverRequestId", - "type": "string", - "description": "Server-generated request ID. Can be used to contact support to investigate a request." - } - } - }, - "default": { - "description": "Unexpected error.", - "schema": { - "$ref": "#/definitions/TsiError" - }, - "headers": { - "x-ms-request-id": { - "x-ms-client-name": "serverRequestId", - "type": "string", - "description": "Server-generated request ID. Can be used to contact support to investigate a request." - } - } - } - } - } - }, - "/timeseries/modelSettings": { - "get": { - "tags": [ - "ModelSettings" - ], - "operationId": "ModelSettings_Get", - "description": "Returns the model settings which includes model display name, Time Series ID properties and default type ID. Every Gen2 environment has a model that is automatically created.", - "x-ms-examples": { - "ModelSettingsGet": { - "$ref": "./examples/ModelSettingsGet.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/ClientRequestId" - }, - { - "$ref": "#/parameters/ClientSessionId" - } - ], - "responses": { - "200": { - "description": "Successful operation.", - "schema": { - "$ref": "#/definitions/ModelSettingsResponse" - }, - "headers": { - "x-ms-request-id": { - "x-ms-client-name": "serverRequestId", - "type": "string", - "description": "Server-generated request ID. Can be used to contact support to investigate a request." - } - } - }, - "default": { - "description": "Unexpected error.", - "schema": { - "$ref": "#/definitions/TsiError" - }, - "headers": { - "x-ms-request-id": { - "x-ms-client-name": "serverRequestId", - "type": "string", - "description": "Server-generated request ID. Can be used to contact support to investigate a request." - } - } - } - } - }, - "patch": { - "tags": [ - "ModelSettings" - ], - "operationId": "ModelSettings_Update", - "description": "Updates time series model settings - either the model name or default type ID.", - "x-ms-examples": { - "ModelSettingsUpdateName": { - "$ref": "./examples/ModelSettingsUpdateName.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/ApiVersion" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/UpdateModelSettingsRequest" - }, - "description": "Model settings update request body." - }, - { - "$ref": "#/parameters/ClientRequestId" - }, - { - "$ref": "#/parameters/ClientSessionId" - } - ], - "responses": { - "200": { - "description": "Successful operation returns new full model settings.", - "schema": { - "$ref": "#/definitions/ModelSettingsResponse" - }, - "headers": { - "x-ms-request-id": { - "x-ms-client-name": "serverRequestId", - "type": "string", - "description": "Server-generated request ID. Can be used to contact support to investigate a request." - } - } - }, - "default": { - "description": "Unexpected error.", - "schema": { - "$ref": "#/definitions/TsiError" - }, - "headers": { - "x-ms-request-id": { - "x-ms-client-name": "serverRequestId", - "type": "string", - "description": "Server-generated request ID. Can be used to contact support to investigate a request." - } - } - } - } - } - }, - "/timeseries/query": { - "post": { - "tags": [ - "Query" - ], - "operationId": "Query_Execute", - "description": "Executes Time Series Query in pages of results - Get Events, Get Series or Aggregate Series.", - "x-ms-examples": { - "QueryAggregateSeriesPage1": { - "$ref": "./examples/QueryAggregateSeriesPage1.json" - }, - "QueryAggregateSeriesPage2": { - "$ref": "./examples/QueryAggregateSeriesPage2.json" - }, - "ColdStoreQueryAggregateSeriesPage1": { - "$ref": "./examples/ColdStoreQueryAggregateSeriesPage1.json" - }, - "ColdStoreQueryAggregateSeriesPage2": { - "$ref": "./examples/ColdStoreQueryAggregateSeriesPage2.json" - }, - "WarmStoreQueryAggregateSeriesPage": { - "$ref": "./examples/WarmStoreQueryAggregateSeriesPage.json" - }, - "QueryAggregateSeriesWithSampleInterpolation": { - "$ref": "./examples/QueryAggregateSeriesWithSampleInterpolation.json" - }, - "QueryAggregateSeriesWithCategoricalVariable": { - "$ref": "./examples/QueryAggregateSeriesWithCategoricalVariable.json" - }, - "QueryAggregateSeriesWithCategoricalInterpolatedVariable": { - "$ref": "./examples/QueryAggregateSeriesWithCategoricalInterpolatedVariable.json" - }, - "QueryGetEventsPage1": { - "$ref": "./examples/QueryGetEventsPage1.json" - }, - "QueryGetEventsPage2": { - "$ref": "./examples/QueryGetEventsPage2.json" - }, - "QueryGetEventsPage3": { - "$ref": "./examples/QueryGetEventsPage3.json" - }, - "QueryGetEventsPage4": { - "$ref": "./examples/QueryGetEventsPage4.json" - }, - "ColdStoreQueryGetEventsPage1": { - "$ref": "./examples/ColdStoreQueryGetEventsPage1.json" - }, - "ColdStoreQueryGetEventsPage2": { - "$ref": "./examples/ColdStoreQueryGetEventsPage2.json" - }, - "ColdStoreQueryGetEventsPage3": { - "$ref": "./examples/ColdStoreQueryGetEventsPage3.json" - }, - "ColdStoreQueryGetEventsPage4": { - "$ref": "./examples/ColdStoreQueryGetEventsPage4.json" - }, - "WarmStoreQueryGetEventsPage1": { - "$ref": "./examples/WarmStoreQueryGetEventsPage1.json" - }, - "WarmStoreQueryGetEventsPage2": { - "$ref": "./examples/WarmStoreQueryGetEventsPage2.json" - }, - "WarmStoreQueryGetEventsPage3": { - "$ref": "./examples/WarmStoreQueryGetEventsPage3.json" - }, - "WarmStoreQueryGetEventsPage4": { - "$ref": "./examples/WarmStoreQueryGetEventsPage4.json" - }, - "QueryGetEventsWithTakePage1": { - "$ref": "./examples/QueryGetEventsWithTakePage1.json" - }, - "QueryGetEventsWithTakePage2": { - "$ref": "./examples/QueryGetEventsWithTakePage2.json" - }, - "QueryGetSeriesPage1": { - "$ref": "./examples/QueryGetSeriesPage1.json" - }, - "QueryGetSeriesPage2": { - "$ref": "./examples/QueryGetSeriesPage2.json" - }, - "QueryGetSeriesPage3": { - "$ref": "./examples/QueryGetSeriesPage3.json" - }, - "QueryGetSeriesWithTakePage1": { - "$ref": "./examples/QueryGetSeriesWithTakePage1.json" - }, - "QueryGetSeriesWithTakePage2": { - "$ref": "./examples/QueryGetSeriesWithTakePage2.json" - }, - "ColdStoreQueryGetSeriesPage1": { - "$ref": "./examples/ColdStoreQueryGetSeriesPage1.json" - }, - "ColdStoreQueryGetSeriesPage2": { - "$ref": "./examples/ColdStoreQueryGetSeriesPage2.json" - }, - "ColdStoreQueryGetSeriesPage3": { - "$ref": "./examples/ColdStoreQueryGetSeriesPage3.json" - }, - "WarmStoreQueryGetSeriesPage1": { - "$ref": "./examples/WarmStoreQueryGetSeriesPage1.json" - }, - "WarmStoreQueryGetSeriesPage2": { - "$ref": "./examples/WarmStoreQueryGetSeriesPage2.json" - }, - "WarmStoreQueryGetSeriesPage3": { - "$ref": "./examples/WarmStoreQueryGetSeriesPage3.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/StoreType" - }, - { - "$ref": "#/parameters/ContinuationToken" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/QueryRequest" - }, - "description": "Time series query request body." - }, - { - "$ref": "#/parameters/ClientRequestId" - }, - { - "$ref": "#/parameters/ClientSessionId" - } - ], - "responses": { - "200": { - "description": "Successful query.", - "schema": { - "$ref": "#/definitions/QueryResultPage" - }, - "headers": { - "x-ms-request-id": { - "x-ms-client-name": "serverRequestId", - "type": "string", - "description": "Server-generated request ID. Can be used to contact support to investigate a request." - } - } - }, - "default": { - "description": "Unexpected error.", - "schema": { - "$ref": "#/definitions/TsiError" - }, - "headers": { - "x-ms-request-id": { - "x-ms-client-name": "serverRequestId", - "type": "string", - "description": "Server-generated request ID. Can be used to contact support to investigate a request." - } - } - } - } - } - }, - "/timeseries/instances": { - "get": { - "tags": [ - "TimeSeriesInstances" - ], - "operationId": "TimeSeriesInstances_Get", - "description": "Gets time series instances in pages.", - "x-ms-examples": { - "InstancesGetPage1": { - "$ref": "./examples/InstancesGetPage1.json" - }, - "InstancesGetPage2": { - "$ref": "./examples/InstancesGetPage2.json" - }, - "InstancesGetPage3": { - "$ref": "./examples/InstancesGetPage3.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/ContinuationToken" - }, - { - "$ref": "#/parameters/ClientRequestId" - }, - { - "$ref": "#/parameters/ClientSessionId" - } - ], - "responses": { - "200": { - "description": "Successful operation.", - "schema": { - "$ref": "#/definitions/GetInstancesPage" - }, - "headers": { - "x-ms-request-id": { - "x-ms-client-name": "serverRequestId", - "type": "string", - "description": "Server-generated request ID. Can be used to contact support to investigate a request." - } - } - }, - "default": { - "description": "Unexpected error.", - "schema": { - "$ref": "#/definitions/TsiError" - }, - "headers": { - "x-ms-request-id": { - "x-ms-client-name": "serverRequestId", - "type": "string", - "description": "Server-generated request ID. Can be used to contact support to investigate a request." - } - } - } - } - } - }, - "/timeseries/instances/$batch": { - "post": { - "tags": [ - "TimeSeriesInstances" - ], - "operationId": "TimeSeriesInstances_ExecuteBatch", - "description": "Executes a batch get, create, update, delete operation on multiple time series instances.", - "x-ms-examples": { - "InstancesBatchDeleteByIds": { - "$ref": "./examples/InstancesBatchDeleteByIds.json" - }, - "InstancesBatchDeleteByNames": { - "$ref": "./examples/InstancesBatchDeleteByNames.json" - }, - "InstancesBatchGetByIds": { - "$ref": "./examples/InstancesBatchGetByIds.json" - }, - "InstancesBatchGetByNames": { - "$ref": "./examples/InstancesBatchGetByNames.json" - }, - "InstancesBatchUpdate": { - "$ref": "./examples/InstancesBatchUpdate.json" - }, - "InstancesBatchPut": { - "$ref": "./examples/InstancesBatchPut.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/ApiVersion" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/InstancesBatchRequest" - }, - "description": "Time series instances suggest request body." - }, - { - "$ref": "#/parameters/ClientRequestId" - }, - { - "$ref": "#/parameters/ClientSessionId" - } - ], - "responses": { - "200": { - "description": "Successful operation.", - "schema": { - "$ref": "#/definitions/InstancesBatchResponse" - }, - "headers": { - "x-ms-request-id": { - "x-ms-client-name": "serverRequestId", - "type": "string", - "description": "Server-generated request ID. Can be used to contact support to investigate a request." - } - } - }, - "default": { - "description": "Unexpected error.", - "schema": { - "$ref": "#/definitions/TsiError" - }, - "headers": { - "x-ms-request-id": { - "x-ms-client-name": "serverRequestId", - "type": "string", - "description": "Server-generated request ID. Can be used to contact support to investigate a request." - } - } - } - } - } - }, - "/timeseries/instances/suggest": { - "post": { - "tags": [ - "TimeSeriesInstances" - ], - "operationId": "TimeSeriesInstances_Suggest", - "description": "Suggests keywords based on time series instance attributes to be later used in Search Instances.", - "x-ms-examples": { - "InstancesSuggest": { - "$ref": "./examples/InstancesSuggest.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/ApiVersion" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/InstancesSuggestRequest" - }, - "description": "Time series instances suggest request body." - }, - { - "$ref": "#/parameters/ClientRequestId" - }, - { - "$ref": "#/parameters/ClientSessionId" - } - ], - "responses": { - "200": { - "description": "Successful operation.", - "schema": { - "$ref": "#/definitions/InstancesSuggestResponse" - }, - "headers": { - "x-ms-request-id": { - "x-ms-client-name": "serverRequestId", - "type": "string", - "description": "Server-generated request ID. Can be used to contact support to investigate a request." - } - } - }, - "default": { - "description": "Unexpected error.", - "schema": { - "$ref": "#/definitions/TsiError" - }, - "headers": { - "x-ms-request-id": { - "x-ms-client-name": "serverRequestId", - "type": "string", - "description": "Server-generated request ID. Can be used to contact support to investigate a request." - } - } - } - } - } - }, - "/timeseries/instances/search": { - "post": { - "tags": [ - "TimeSeriesInstances" - ], - "operationId": "TimeSeriesInstances_Search", - "description": "Partial list of hits on search for time series instances based on instance attributes.", - "x-ms-examples": { - "SearchInstancesHierarchiesDefaultInputPage1": { - "$ref": "./examples/SearchInstancesHierarchiesDefaultInputPage1.json" - }, - "SearchInstancesHierarchiesDefaultInputPage2": { - "$ref": "./examples/SearchInstancesHierarchiesDefaultInputPage2.json" - }, - "SearchInstancesHierarchiesDefaultInputPage3": { - "$ref": "./examples/SearchInstancesHierarchiesDefaultInputPage3.json" - }, - "SearchInstancesUntilChildren": { - "$ref": "./examples/SearchInstancesUntilChildren.json" - }, - "SearchInstancesDefault": { - "$ref": "./examples/SearchInstancesDefault.json" - }, - "SearchInstancesExpandHierarchiesOnly": { - "$ref": "./examples/SearchInstancesExpandHierarchiesOnly.json" - }, - "SearchInstancesRecursive": { - "$ref": "./examples/SearchInstancesRecursive.json" - }, - "SearchInstancesOneLevel": { - "$ref": "./examples/SearchInstancesOneLevel.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/ContinuationToken" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/SearchInstancesRequest" - }, - "description": "Time series instances search request body." - }, - { - "$ref": "#/parameters/ClientRequestId" - }, - { - "$ref": "#/parameters/ClientSessionId" - } - ], - "responses": { - "200": { - "description": "Successful search response.", - "schema": { - "$ref": "#/definitions/SearchInstancesResponsePage" - }, - "headers": { - "x-ms-request-id": { - "x-ms-client-name": "serverRequestId", - "type": "string", - "description": "Server-generated request ID. Can be used to contact support to investigate a request." - } - } - }, - "default": { - "description": "Unexpected error.", - "schema": { - "$ref": "#/definitions/TsiError" - }, - "headers": { - "x-ms-request-id": { - "x-ms-client-name": "serverRequestId", - "type": "string", - "description": "Server-generated request ID. Can be used to contact support to investigate a request." - } - } - } - } - } - }, - "/timeseries/types": { - "get": { - "tags": [ - "TimeSeriesTypes" - ], - "operationId": "TimeSeriesTypes_Get", - "description": "Gets time series types in pages.", - "x-ms-examples": { - "TypesGetPage1": { - "$ref": "./examples/TypesGetPage1.json" - }, - "TypesGetPage2": { - "$ref": "./examples/TypesGetPage2.json" - }, - "TypesGetPage3": { - "$ref": "./examples/TypesGetPage3.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/ContinuationToken" - }, - { - "$ref": "#/parameters/ClientRequestId" - }, - { - "$ref": "#/parameters/ClientSessionId" - } - ], - "responses": { - "200": { - "description": "Successful operation.", - "schema": { - "$ref": "#/definitions/GetTypesPage" - }, - "headers": { - "x-ms-request-id": { - "x-ms-client-name": "serverRequestId", - "type": "string", - "description": "Server-generated request ID. Can be used to contact support to investigate a request." - } - } - }, - "default": { - "description": "Unexpected error.", - "schema": { - "$ref": "#/definitions/TsiError" - }, - "headers": { - "x-ms-request-id": { - "x-ms-client-name": "serverRequestId", - "type": "string", - "description": "Server-generated request ID. Can be used to contact support to investigate a request." - } - } - } - } - } - }, - "/timeseries/types/$batch": { - "post": { - "tags": [ - "TimeSeriesTypes" - ], - "operationId": "TimeSeriesTypes_ExecuteBatch", - "description": "Executes a batch get, create, update, delete operation on multiple time series types.", - "x-ms-examples": { - "TypesBatchGetByIds": { - "$ref": "./examples/TypesBatchGetByIds.json" - }, - "TypesBatchGetByNames": { - "$ref": "./examples/TypesBatchGetByNames.json" - }, - "TypesBatchPut": { - "$ref": "./examples/TypesBatchPut.json" - }, - "TypesBatchDeleteByIds": { - "$ref": "./examples/TypesBatchDeleteByIds.json" - }, - "TypesBatchDeleteByNames": { - "$ref": "./examples/TypesBatchDeleteByNames.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/ApiVersion" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/TypesBatchRequest" - }, - "description": "Time series types batch request body." - }, - { - "$ref": "#/parameters/ClientRequestId" - }, - { - "$ref": "#/parameters/ClientSessionId" - } - ], - "responses": { - "200": { - "description": "Successful operation.", - "schema": { - "$ref": "#/definitions/TypesBatchResponse" - }, - "headers": { - "x-ms-request-id": { - "x-ms-client-name": "serverRequestId", - "type": "string", - "description": "Server-generated request ID. Can be used to contact support to investigate a request." - } - } - }, - "default": { - "description": "Unexpected error.", - "schema": { - "$ref": "#/definitions/TsiError" - }, - "headers": { - "x-ms-request-id": { - "x-ms-client-name": "serverRequestId", - "type": "string", - "description": "Server-generated request ID. Can be used to contact support to investigate a request." - } - } - } - } - } - }, - "/timeseries/hierarchies": { - "get": { - "tags": [ - "TimeSeriesHierarchies" - ], - "operationId": "TimeSeriesHierarchies_Get", - "description": "Returns time series hierarchies definitions in pages.", - "x-ms-examples": { - "HierarchiesGetPage1": { - "$ref": "./examples/HierarchiesGetPage1.json" - }, - "HierarchiesGetPage2": { - "$ref": "./examples/HierarchiesGetPage2.json" - }, - "HierarchiesGetPage3": { - "$ref": "./examples/HierarchiesGetPage3.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/ContinuationToken" - }, - { - "$ref": "#/parameters/ClientRequestId" - }, - { - "$ref": "#/parameters/ClientSessionId" - } - ], - "responses": { - "200": { - "description": "Successful operation.", - "schema": { - "$ref": "#/definitions/GetHierarchiesPage" - }, - "headers": { - "x-ms-request-id": { - "x-ms-client-name": "serverRequestId", - "type": "string", - "description": "Server-generated request ID. Can be used to contact support to investigate a request." - } - } - }, - "default": { - "description": "Unexpected error.", - "schema": { - "$ref": "#/definitions/TsiError" - }, - "headers": { - "x-ms-request-id": { - "x-ms-client-name": "serverRequestId", - "type": "string", - "description": "Server-generated request ID. Can be used to contact support to investigate a request." - } - } - } - } - } - }, - "/timeseries/hierarchies/$batch": { - "post": { - "tags": [ - "TimeSeriesHierarchies" - ], - "operationId": "TimeSeriesHierarchies_ExecuteBatch", - "description": "Executes a batch get, create, update, delete operation on multiple time series hierarchy definitions.", - "x-ms-examples": { - "HierarchiesBatchGetByIds": { - "$ref": "./examples/HierarchiesBatchGetByIds.json" - }, - "HierarchiesBatchGetByNames": { - "$ref": "./examples/HierarchiesBatchGetByNames.json" - }, - "HierarchiesBatchPut": { - "$ref": "./examples/HierarchiesBatchPut.json" - }, - "HierarchiesBatchDeleteByIds": { - "$ref": "./examples/HierarchiesBatchDeleteByIds.json" - }, - "HierarchiesBatchDeleteByNames": { - "$ref": "./examples/HierarchiesBatchDeleteByNames.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/ApiVersion" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/HierarchiesBatchRequest" - }, - "description": "Time series hierarchies batch request body." - }, - { - "$ref": "#/parameters/ClientRequestId" - }, - { - "$ref": "#/parameters/ClientSessionId" - } - ], - "responses": { - "200": { - "description": "Successful operation.", - "schema": { - "$ref": "#/definitions/HierarchiesBatchResponse" - }, - "headers": { - "x-ms-request-id": { - "x-ms-client-name": "serverRequestId", - "type": "string", - "description": "Server-generated request ID. Can be used to contact support to investigate a request." - } - } - }, - "default": { - "description": "Unexpected error.", - "schema": { - "$ref": "#/definitions/TsiError" - }, - "headers": { - "x-ms-request-id": { - "x-ms-client-name": "serverRequestId", - "type": "string", - "description": "Server-generated request ID. Can be used to contact support to investigate a request." - } - } - } - } - } - } - }, - "definitions": { - "AvailabilityResponse": { - "description": "Response of Get Availability operation. When environment has no data, availability property is null.", - "type": "object", - "properties": { - "availability": { - "description": "Event availability information when environment contains events. When environment has no data yet, this property is null or not present.", - "readOnly": true, - "$ref": "#/definitions/Availability" - } - } - }, - "Availability": { - "description": "Event availability information when environment contains events. Contains time range of events and approximate distribution of events over time.", - "type": "object", - "properties": { - "range": { - "description": "Minimum and maximum values of event timestamp ($ts) property.", - "$ref": "#/definitions/DateTimeRange", - "readOnly": true - }, - "intervalSize": { - "description": "Interval size for the returned distribution of the events. Returned interval is selected to return a reasonable number of points. All intervals are the same size. On the wire interval is specified in ISO-8601 duration format. One month is always converted to 30 days, and one year is always 365 days. Examples: 1 minute is \"PT1M\", 1 millisecond is \"PT0.001S\". For more information, see https://www.w3.org/TR/xmlschema-2/#duration", - "readOnly": true, - "type": "string", - "format": "duration" - }, - "distribution": { - "additionalProperties": { - "description": "Key value pair where key represents the interval denoted by the date time of the start of the interval and the value is the number of events in that interval.", - "readOnly": true, - "type": "integer", - "format": "int32" - } - } - } - }, - "GetEventSchemaRequest": { - "description": "Request to get the event schema of all events within a given search span.", - "type": "object", - "properties": { - "searchSpan": { - "description": "The range of time on which the query is executed. Cannot be null.", - "$ref": "#/definitions/DateTimeRange" - } - }, - "required": [ - "searchSpan" - ] - }, - "EventSchema": { - "description": "Event schema of all events within a given search span. Event schema is a set of property definitions. Properties are identified by both name and type. Different events can have properties with same name, but different type. Event schema may not be contain all persisted properties when there are too many properties.", - "type": "object", - "properties": { - "properties": { - "description": "A set of property definitions. When environment has no data, the returned array is empty.", - "readOnly": true, - "type": "array", - "items": { - "$ref": "#/definitions/EventProperty" - } - } - } - }, - "QueryRequest": { - "type": "object", - "description": "Request to execute a time series query over events. Exactly one of \"getEvents\", \"getSeries\" or \"aggregateSeries\" must be set.", - "properties": { - "getEvents": { - "description": "Get Events query. Allows to retrieve raw events for a given Time Series ID and search span.", - "$ref": "#/definitions/GetEvents" - }, - "getSeries": { - "description": "Get Series query. Allows to retrieve time series of calculated variable values from events for a given Time Series ID and search span.", - "$ref": "#/definitions/GetSeries" - }, - "aggregateSeries": { - "description": "Aggregate Series query. Allows to calculate an aggregated time series from events for a given Time Series ID and search span.", - "$ref": "#/definitions/AggregateSeries" - } - } - }, - "GetEvents": { - "description": "Get Events query. Allows to retrieve raw events for a given Time Series ID and search span.", - "type": "object", - "properties": { - "timeSeriesId": { - "description": "A single Time Series ID value that uniquely identifies a single time series instance (e.g. a device). Note that a single Time Series ID can be composite if multiple properties are specified as Time Series ID at environment creation time. The position and type of values must match Time Series ID properties specified on the environment and returned by Get Model Setting API. Cannot be null.", - "$ref": "#/definitions/TimeSeriesId" - }, - "searchSpan": { - "description": "The range of time on which the query is executed. Cannot be null.", - "$ref": "#/definitions/DateTimeRange" - }, - "filter": { - "description": "Optional top-level filter for the query which will be applied to all the variables in the query. Example: \"$event.Status.String='Good'\". Can be null.", - "$ref": "#/definitions/Tsx" - }, - "projectedProperties": { - "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": { - "$ref": "#/definitions/EventProperty" - } - }, - "take": { - "description": "Maximum number of property values in the whole response set, not the maximum number of property values per page. Defaults to 10,000 when not set. Maximum value of take can be 250,000.", - "type": "integer", - "format": "int32" - } - }, - "required": [ - "timeSeriesId", - "searchSpan" - ] - }, - "GetSeries": { - "description": "Get Series query. Allows to retrieve time series of calculated variable values from events for a given Time Series ID and search span.", - "type": "object", - "properties": { - "timeSeriesId": { - "description": "A single Time Series ID value that uniquely identifies a single time series instance (e.g. a device). Note that a single Time Series ID can be composite if multiple properties are specified as Time Series ID at environment creation time. The position and type of values must match Time Series ID properties specified on the environment and returned by Get Model Setting API. Cannot be null.", - "$ref": "#/definitions/TimeSeriesId" - }, - "searchSpan": { - "description": "The range of time on which the query is executed. Cannot be null.", - "$ref": "#/definitions/DateTimeRange" - }, - "filter": { - "description": "Top-level filter over the events that restricts the number of events being considered for computation. This filter is AND'ed with filter in each variable. Example: \"$event.Status.String='Good'\". Optional.", - "$ref": "#/definitions/Tsx" - }, - "projectedVariables": { - "description": "Selected variables that needs to be projected in the query result. When it is null or not set, all the variables from inlineVariables and time series type in the model are returned. Can be null.", - "type": "array", - "items": { - "type": "string" - } - }, - "inlineVariables": { - "description": "Optional inline variables apart from the ones already defined in the time series type in the model. When the inline variable name is the same name as in the model, the inline variable definition takes precedence. Can be null.", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/Variable" - } - }, - "take": { - "description": "Maximum number of property values in the whole response set, not the maximum number of property values per page. Defaults to 10,000 when not set. Maximum value of take can be 250,000.", - "type": "integer", - "format": "int32" - } - }, - "required": [ - "timeSeriesId", - "searchSpan" - ] - }, - "AggregateSeries": { - "description": "Aggregate Series query. Allows to calculate an aggregated time series from events for a given Time Series ID and search span.", - "type": "object", - "properties": { - "timeSeriesId": { - "description": "A single Time Series ID value that uniquely identifies a single time series instance (e.g. a device). Note that a single Time Series ID can be composite if multiple properties are specified as Time Series ID at environment creation time. The position and type of values must match Time Series ID properties specified on the environment and returned by Get Model Setting API. Cannot be null.", - "$ref": "#/definitions/TimeSeriesId" - }, - "searchSpan": { - "description": "The range of time on which the query is executed. Cannot be null.", - "$ref": "#/definitions/DateTimeRange" - }, - "filter": { - "description": "Top-level filter over the events that restricts the number of events being considered for computation. This filter is AND'ed with filter in each variable. Example: \"$event.Status.String='Good'\". Optional.", - "$ref": "#/definitions/Tsx" - }, - "interval": { - "type": "string", - "format": "duration", - "description": "Interval size is specified in ISO-8601 duration format. All intervals are the same size. One month is always converted to 30 days, and one year is always 365 days. Examples: 1 minute is \"PT1M\", 1 millisecond is \"PT0.001S\". For more information, see https://www.w3.org/TR/xmlschema-2/#duration" - }, - "projectedVariables": { - "description": "This allows the user to optionally select the variables that needs to be projected. When it is null or not set, all the variables from inlineVariables and model are returned. Can be null.", - "type": "array", - "items": { - "type": "string" - } - }, - "inlineVariables": { - "description": "This allows the user the optionally define inline-variables apart from the ones already defined in the model. When the inline variable names have the same name as the model, the inline variable definition takes precedence. Can be null.", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/Variable" - } - } - }, - "required": [ - "timeSeriesId", - "searchSpan", - "interval" - ] - }, - "TimeSeriesId": { - "description": "A single Time Series ID value that is an array of primitive values that uniquely identifies a time series instance (e.g. a single device). Note that a single Time Series ID can be composite if multiple properties are specified as Time Series ID at environment creation time. The position and type of values must match Time Series ID properties specified on the environment and returned by Get Model Setting API. Cannot be empty.", - "type": "array", - "items": { - "description": "A single Time Series ID value that is an array of primitive values that uniquely identifies a time series instance (e.g. a single device). Note that a single Time Series ID can be composite if multiple properties are specified as Time Series ID at environment creation time. The position and type of values must match Time Series ID properties specified on the environment and returned by Get Model Setting API. Cannot be empty." - }, - "minItems": 1 - }, - "Tsx": { - "description": "Time series expression (TSX) written as a single string. Examples: \"$event.Status.String='Good'\", \"avg($event.Temperature)\". Refer to the documentation on how to write time series expressions.", - "type": "object", - "properties": { - "tsx": { - "description": "Time series expression (TSX) written as a single string. Examples: \"$event.Status.String='Good'\", \"avg($event.Temperature)\". Refer to the documentation on how to write time series expressions.", - "type": "string" - } - }, - "required": [ - "tsx" - ] - }, - "Interpolation": { - "description": "The interpolation operation to be performed on the raw data points. Currently, only sampling of interpolated time series is allowed. Allowed aggregate function - eg: left($value). Can be null if no interpolation needs to be applied.", - "type": "object", - "properties": { - "kind": { - "description": "The type of interpolation technique : \"Linear\" or \"Step\".", - "type": "string", - "enum": [ - "Linear", - "Step" - ], - "x-ms-enum": { - "name": "InterpolationKind", - "modelAsString": true - } - }, - "boundary": { - "description": "The time range to the left and right of the search span to be used for Interpolation. This is helpful in scenarios where the data points are missing close to the start or end of the input search span. Can be null.", - "type": "object", - "properties": { - "span": { - "type": "string", - "format": "duration" - } - } - } - } - }, - "DateTimeRange": { - "description": "The range of time. Cannot be null or negative.", - "type": "object", - "properties": { - "from": { - "description": "Start timestamp of the time range. Start timestamp is inclusive when used in time series query requests. Events that have this timestamp are included.", - "type": "string", - "format": "date-time" - }, - "to": { - "description": "End timestamp of the time range. End timestamp is exclusive when used in time series query requests. Events that match this timestamp are excluded. Note that end timestamp is inclusive when returned by Get Availability (meaning that there is an event with this exact \"to\" timestamp).", - "type": "string", - "format": "date-time" - } - }, - "required": [ - "from", - "to" - ] - }, - "NumericVariable": { - "description": "Numeric variable represents a single continuous numeric signal that can be reconstructed using interpolation.", - "x-ms-discriminator-value": "numeric", - "allOf": [ - { - "$ref": "#/definitions/Variable" - }, - { - "type": "object", - "properties": { - "value": { - "description": "Value time series expression is used to represent the value of the signal that is going to be aggregated or interpolated. For example, temperature values from the event is represented like this: \"$event.Temperature.Double\".", - "$ref": "#/definitions/Tsx" - }, - "interpolation": { - "$ref": "#/definitions/Interpolation" - }, - "aggregation": { - "description": "Aggregation time series expression when kind is \"numeric\" is used to represent the aggregation that needs to be performed on the $value expression. This requires $value to be specified and can only use $value inside the aggregate functions. For example, aggregation for calculating minimum of the $value is written as: \"min($value)\".", - "$ref": "#/definitions/Tsx" - } - } - } - ], - "required": [ - "kind", - "value", - "aggregation" - ] - }, - "AggregateVariable": { - "description": "Aggregate variable represents any aggregation calculation. Aggregate Variables does not support interpolation.", - "x-ms-discriminator-value": "aggregate", - "allOf": [ - { - "$ref": "#/definitions/Variable" - }, - { - "type": "object", - "properties": { - "aggregation": { - "description": "Aggregation time series expression when kind is \"aggregate\" is used to represent the aggregation that needs to be performed directly using event properties like \"$event.Temperature\". For example, aggregation for calculating range of temperature changes can be written as: \"max($event.Temperature)-min($event.Temperature)\".", - "$ref": "#/definitions/Tsx" - } - } - } - ], - "required": [ - "kind", - "aggregation" - ] - }, - "CategoricalVariable": { - "description": "Categorical variable represents signal that needs to be analyzed based on the count or duration of occurrence of limited set of defined values.", - "x-ms-discriminator-value": "categorical", - "allOf": [ - { - "$ref": "#/definitions/Variable" - }, - { - "type": "object", - "properties": { - "value": { - "description": "Value time series expression is used to represent the value of the signal that is going to be categorized. It can evaluate to only 'String' or 'Long' type for categorical variables.", - "$ref": "#/definitions/Tsx" - }, - "interpolation": { - "description": "Categorical variable supports only 'step' interpolation.", - "$ref": "#/definitions/Interpolation" - }, - "categories": { - "type": "array", - "items": { - "$ref": "#/definitions/TimeSeriesAggregateCategory" - } - }, - "defaultCategory": { - "$ref": "#/definitions/TimeSeriesDefaultCategory" - } - } - } - ], - "required": [ - "kind", - "value", - "defaultCategory" - ] - }, - "TimeSeriesAggregateCategory": { - "description": "Category used in categorical variables. A category is defined by 'label' and the 'values' that are assigned this label.", - "type": "object", - "properties": { - "label": { - "description": "The name of the category which will be used in constructing the output variable names.", - "type": "string" - }, - "values": { - "description": "The list of values that a category maps to. Can be either a unique list of string or list of long.", - "type": "array", - "items": { - "type": "object" - } - } - }, - "required": [ - "label", - "values" - ] - }, - "TimeSeriesDefaultCategory": { - "description": "Represents the default category.", - "type": "object", - "properties": { - "label": { - "description": "The name of the default category which will be assigned to the values that does not match any of those that are defined in the 'categories'.", - "type": "string" - } - }, - "required": [ - "label" - ] - }, - "Variable": { - "description": "Variables are named calculations over values from the events. Time Series Insights variable definitions contain formula and computation rules. Variables are stored in the type definition in Time Series Model and can be provided inline via Query APIs to override the stored definition.", - "type": "object", - "discriminator": "kind", - "properties": { - "kind": { - "description": "Allowed \"kind\" values are - \"numeric\" or \"aggregate\". While \"numeric\" allows you to specify value of the reconstructed signal and the expression to aggregate them, the \"aggregate\" kind lets you directly aggregate on the event properties without specifying value.", - "type": "string" - }, - "filter": { - "description": "Filter over the events that restricts the number of events being considered for computation. Example: \"$event.Status.String='Good'\". Optional.", - "$ref": "#/definitions/Tsx" - } - }, - "required": [ - "kind" - ] - }, - "QueryResultPage": { - "description": "A single page of query results. If query has not finished yet, a page will have continuation token set. In this case, to get the next page of results, send the same request again with continuation token parameter. If query has completed, the continuation token is null. It is also possible to get an empty page with only continuation token set when no query results have been computed yet. If paging has completed (continuation token is null), then timestamps and properties may be empty if there is no data to return.", - "allOf": [ - { - "$ref": "#/definitions/PagedResponse" - }, - { - "type": "object", - "properties": { - "timestamps": { - "description": "The timestamps of the values of the time series. If an aggregation over intervals is used, timestamps represent the start of corresponding intervals. If events are retrieved, timestamps are values of timestamp $ts property of events. Can be null if server was unable to fill the page in this request, or can be empty if there are no more objects when continuation token is null.", - "readOnly": true, - "type": "array", - "items": { - "type": "string", - "format": "date-time" - } - }, - "properties": { - "description": "Collection of time series properties and values for each of the timestamps. Can be null if server was unable to fill the page in this request, or can be empty if there are no more objects when continuation token is null.", - "readOnly": true, - "type": "array", - "items": { - "$ref": "#/definitions/PropertyValues" - } - }, - "progress": { - "description": "Approximate progress of the query in percentage. It can be between 0 and 100. When the continuation token in the response is null, the progress is expected to be 100.", - "readOnly": true, - "type": "number", - "format": "double" - } - } - } - ] - }, - "PropertyValues": { - "description": "Values of a single property corresponding to the timestamps. May contain nulls. Type of values matches the type of property.", - "allOf": [ - { - "$ref": "#/definitions/EventProperty" - }, - { - "type": "object", - "properties": { - "values": { - "description": "Values of a single property corresponding to the timestamps. May contain nulls. Type of values matches the type of property.", - "type": "array", - "items": {} - } - } - } - ] - }, - "GetInstancesPage": { - "description": "Partial list of time series instances returned in a single request.", - "allOf": [ - { - "$ref": "#/definitions/PagedResponse" - }, - { - "type": "object", - "properties": { - "instances": { - "description": "Partial list of time series instances returned in a single request. Can be empty if server was unable to fill the page in this request, or there is no more objects when continuation token is null.", - "readOnly": true, - "type": "array", - "items": { - "$ref": "#/definitions/TimeSeriesInstance" - } - } - } - } - ] - }, - "TimeSeriesInstance": { - "description": "Time series instances are the time series themselves. In most cases, the deviceId or assetId is the unique identifier of the asset in the environment. Instances have descriptive information associated with them called instance fields. At a minimum, instance fields include hierarchy information. They can also include useful, descriptive data like the manufacturer, operator, or the last service date.", - "type": "object", - "properties": { - "timeSeriesId": { - "description": "Time Series ID that uniquely identifies the instance. It matches Time Series ID properties in an environment. Immutable, never null.", - "$ref": "#/definitions/TimeSeriesId" - }, - "typeId": { - "description": "This represents the type that this instance belongs to. Never null.", - "type": "string" - }, - "name": { - "description": "Optional name of the instance which is unique in an environment. Names acts as a mutable alias or display name of the time series instance. Mutable, may be null.", - "type": "string" - }, - "description": { - "description": "This optional field contains description about the instance.", - "type": "string" - }, - "hierarchyIds": { - "description": "Set of time series hierarchy IDs that the instance belong to. May be null.", - "type": "array", - "items": { - "type": "string" - } - }, - "instanceFields": { - "description": "Set of key-value pairs that contain user-defined instance properties. It may be null. Supported property value types are: bool, string, long, double and it cannot be nested or null.", - "type": "object", - "additionalProperties": {} - } - }, - "required": [ - "timeSeriesId", - "typeId" - ] - }, - "InstancesBatchRequest": { - "description": "Request to perform a single operation on a batch of instances. Exactly one of \"get\", \"put\", \"update\" or \"delete\" must be set.", - "type": "object", - "properties": { - "get": { - "description": "Time series IDs or names of time series instances to return.", - "$ref": "#/definitions/InstancesRequestBatchGetOrDelete" - }, - "put": { - "description": "Time series instances to be created or updated.", - "type": "array", - "items": { - "$ref": "#/definitions/TimeSeriesInstance" - } - }, - "update": { - "description": "Time series instance to be updated. If instance does not exist, an error is returned.", - "type": "array", - "items": { - "$ref": "#/definitions/TimeSeriesInstance" - } - }, - "delete": { - "description": "Time series instances to be deleted. Time series ID or name may be specified.", - "$ref": "#/definitions/InstancesRequestBatchGetOrDelete" - } - } - }, - "InstancesRequestBatchGetOrDelete": { - "description": "Request to get or delete instances by time series IDs or time series names. Exactly one of \"timeSeriesIds\" or \"names\" must be set.", - "type": "object", - "properties": { - "timeSeriesIds": { - "description": "List of time series IDs of the time series instances to return or delete.", - "type": "array", - "items": { - "$ref": "#/definitions/TimeSeriesId" - } - }, - "names": { - "description": "List of names of the time series instances to return or delete.", - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "InstancesBatchResponse": { - "description": "Response of a single operation on a batch of instances. Only one of \"get\", \"put\", \"update\" or \"delete\" will be set based on the request.", - "type": "object", - "properties": { - "get": { - "description": "List of instance or error objects corresponding by position to the \"get\" array in the request. Instance object is set when operation is successful and error object is set when operation is unsuccessful.", - "readOnly": true, - "type": "array", - "items": { - "$ref": "#/definitions/InstanceOrError" - } - }, - "put": { - "description": "List of error objects corresponding by position to the \"put\" array in the request. Error object is set when operation is unsuccessful.", - "readOnly": true, - "type": "array", - "items": { - "$ref": "#/definitions/InstanceOrError" - } - }, - "update": { - "description": "List of error objects corresponding by position to the \"update\" array in the request. Instance object is set when operation is successful and error object is set when operation is unsuccessful.", - "readOnly": true, - "type": "array", - "items": { - "$ref": "#/definitions/InstanceOrError" - } - }, - "delete": { - "description": "List of error objects corresponding by position to the \"delete\" array in the request. Null means the instance has been deleted, or did not exist. Error object is set when operation is unsuccessful (e.g. when there are events associated with this time series instance).", - "readOnly": true, - "type": "array", - "items": { - "$ref": "#/definitions/TsiErrorBody" - } - } - } - }, - "InstanceOrError": { - "description": "Result of a batch operation on a particular time series instance. Instance object is set when operation is successful (except put operation) and error object is set when operation is unsuccessful.", - "type": "object", - "properties": { - "instance": { - "description": "Time series instance object - set when the operation is successful (except put operation).", - "readOnly": true, - "$ref": "#/definitions/TimeSeriesInstance" - }, - "error": { - "description": "Error object - set when the operation is unsuccessful.", - "readOnly": true, - "$ref": "#/definitions/TsiErrorBody" - } - } - }, - "GetTypesPage": { - "description": "Partial list of time series types returned in a single request.", - "allOf": [ - { - "$ref": "#/definitions/PagedResponse" - }, - { - "type": "object", - "properties": { - "types": { - "description": "Partial list of time series types returned in a single request. Can be empty if server was unable to fill the page with more types in this request, or there is no more types when continuation token is null.", - "readOnly": true, - "type": "array", - "items": { - "$ref": "#/definitions/TimeSeriesType" - } - } - } - } - ] - }, - "TimeSeriesType": { - "description": "Time series type defines variables or formulas for doing computation on events associated with time series instances. Each time series instance is associated with exactly one type. A type can have one or more variables. For example, a time series instance might be of type Temperature Sensor, which consists of the variables avg temperature, min temperature, and max temperature.", - "type": "object", - "properties": { - "id": { - "description": "Case-sensitive unique type identifier that is immutable. Can be null on create or update requests, and then server generates the ID. Not null on get and delete operations.", - "type": "string" - }, - "name": { - "description": "User-given unique name for the type. Mutable, not null.", - "type": "string" - }, - "description": { - "description": "Description of the type. May be null.", - "type": "string" - }, - "variables": { - "description": "Different variables associated with the type. Not empty, not null.", - "additionalProperties": { - "$ref": "#/definitions/Variable" - } - } - }, - "required": [ - "name", - "variables" - ] - }, - "TypesBatchRequest": { - "description": "Request to perform a single operation on a batch of time series types. Exactly one of \"get\", \"put\" or \"delete\" must be set.", - "type": "object", - "properties": { - "get": { - "description": "Definition of what time series types to return.", - "$ref": "#/definitions/TypesRequestBatchGetOrDelete" - }, - "put": { - "description": "Definition of what time series types to update or create.", - "type": "array", - "items": { - "$ref": "#/definitions/TimeSeriesType" - } - }, - "delete": { - "description": "Definition of what time series types to delete.", - "$ref": "#/definitions/TypesRequestBatchGetOrDelete" - } - } - }, - "TypesRequestBatchGetOrDelete": { - "description": "Request to get or delete time series types by IDs or type names. Exactly one of \"typeIds\" or \"names\" must be set.", - "type": "object", - "properties": { - "typeIds": { - "description": "List of IDs of time series types to return or delete.", - "type": "array", - "items": { - "type": "string" - } - }, - "names": { - "description": "List of names of time series types to return or delete.", - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "TypesBatchResponse": { - "description": "Response of a single operation on a batch of time series types. Exactly one of \"get\", \"put\" or \"delete\" will be set.", - "type": "object", - "properties": { - "get": { - "description": "List of types or error objects corresponding by position to the \"get\" array in the request. Type object is set when operation is successful and error object is set when operation is unsuccessful.", - "readOnly": true, - "type": "array", - "items": { - "$ref": "#/definitions/TimeSeriesTypeOrError" - } - }, - "put": { - "description": "List of types or error objects corresponding by position to the \"put\" array in the request. Type object is set when operation is successful and error object is set when operation is unsuccessful.", - "readOnly": true, - "type": "array", - "items": { - "$ref": "#/definitions/TimeSeriesTypeOrError" - } - }, - "delete": { - "description": "List of error objects corresponding by position to the \"delete\" array in the request - null when the operation is successful.", - "type": "array", - "readOnly": true, - "items": { - "$ref": "#/definitions/TsiErrorBody" - } - } - } - }, - "TimeSeriesTypeOrError": { - "description": "Result of a batch operation on a particular time series type. Type object is set when operation is successful and error object is set when operation is unsuccessful.", - "type": "object", - "properties": { - "timeSeriesType": { - "description": "Time series type object - set when the operation is successful.", - "readOnly": true, - "$ref": "#/definitions/TimeSeriesType" - }, - "error": { - "description": "Error object - set when the operation is unsuccessful.", - "readOnly": true, - "$ref": "#/definitions/TsiErrorBody" - } - } - }, - "GetHierarchiesPage": { - "description": "Partial list of time series hierarchies returned in a single request.", - "allOf": [ - { - "$ref": "#/definitions/PagedResponse" - }, - { - "type": "object", - "properties": { - "hierarchies": { - "description": "Partial list of time series hierarchies returned in a single request. Can be empty if server was unable to fill the page in this request, or there is no more objects when continuation token is null.", - "readOnly": true, - "type": "array", - "items": { - "$ref": "#/definitions/TimeSeriesHierarchy" - } - } - } - } - ] - }, - "TimeSeriesHierarchy": { - "description": "Time series hierarchy organizes time series instances into a tree.", - "type": "object", - "properties": { - "id": { - "description": "Case-sensitive unique hierarchy identifier. Can be null while creating hierarchy objects and then server generates the id, not null on get and delete operations.", - "type": "string" - }, - "name": { - "description": "User-given unique name for the type. It is mutable and not null.", - "type": "string" - }, - "source": { - "description": "Definition of how time series hierarchy tree levels are created.", - "type": "object", - "properties": { - "instanceFieldNames": { - "description": "List of instance field names that must be set in all time series instances that belong to this hierarchy. The order of the instance fields defines the levels in the hierarchy.", - "type": "array", - "items": { - "type": "string" - } - } - } - } - }, - "required": [ - "name", - "source" - ] - }, - "HierarchiesBatchRequest": { - "description": "Request to perform a single operation on a batch of hierarchies. Exactly one of \"get\", \"put\" or \"delete\" must be set.", - "type": "object", - "properties": { - "get": { - "description": "\"get\" should be set while fetching specific hierarchies either by IDs or names.", - "$ref": "#/definitions/HierarchiesRequestBatchGetDelete" - }, - "put": { - "description": "\"put\" should be set while creating or updating hierarchies.", - "type": "array", - "items": { - "$ref": "#/definitions/TimeSeriesHierarchy" - } - }, - "delete": { - "description": "\"delete\" should be set while fetching specific hierarchies either by IDs or names.", - "$ref": "#/definitions/HierarchiesRequestBatchGetDelete" - } - } - }, - "HierarchiesRequestBatchGetDelete": { - "description": "Request to get or delete multiple time series hierarchies. Exactly one of \"hierarchyIds\" or \"names\" must be set.", - "type": "object", - "properties": { - "hierarchyIds": { - "description": "List of hierarchy IDs.", - "type": "array", - "items": { - "type": "string" - } - }, - "names": { - "description": "List of hierarchy names.", - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "HierarchiesBatchResponse": { - "description": "Response of a single operation on a batch of time series hierarchies. Only one of \"get\", \"put\" or \"delete\" will be set.", - "type": "object", - "properties": { - "get": { - "description": "List of hierarchy or error objects corresponding by position to the \"get\" array in the request. Hierarchy object is set when operation is successful and error object is set when operation is unsuccessful.", - "readOnly": true, - "type": "array", - "items": { - "$ref": "#/definitions/TimeSeriesHierarchyOrError" - } - }, - "put": { - "description": "List of hierarchy or error object corresponding by position to the \"put\" array in the request. Hierarchy object is set when operation is successful and error object is set when operation is unsuccessful.", - "readOnly": true, - "type": "array", - "items": { - "$ref": "#/definitions/TimeSeriesHierarchyOrError" - } - }, - "delete": { - "description": "List of error objects corresponding by position to the \"delete\" array in the request - null when the operation is successful.", - "readOnly": true, - "type": "array", - "items": { - "$ref": "#/definitions/TsiErrorBody" - } - } - } - }, - "TimeSeriesHierarchyOrError": { - "description": "Result of a batch operation on a particular time series hierarchy. Hierarchy is set when operation is successful and error object is set when operation is unsuccessful.", - "type": "object", - "properties": { - "hierarchy": { - "description": "Time series hierarchy object - set when the operation is successful.", - "readOnly": true, - "$ref": "#/definitions/TimeSeriesHierarchy" - }, - "error": { - "description": "Error object - set when the operation is unsuccessful.", - "readOnly": true, - "$ref": "#/definitions/TsiErrorBody" - } - } - }, - "ModelSettingsResponse": { - "description": "Response containing full time series model settings which include model name, Time Series ID properties and default type ID.", - "type": "object", - "properties": { - "modelSettings": { - "description": "Model settings including model name, Time Series ID properties and default type ID.", - "readOnly": true, - "$ref": "#/definitions/TimeSeriesModelSettings" - } - } - }, - "TimeSeriesModelSettings": { - "description": "Time series model settings including model name, Time Series ID properties and default type ID.", - "type": "object", - "properties": { - "name": { - "description": "Time series model display name which is shown in the UX. Examples: \"Temperature Sensors\", \"MyDevices\".", - "readOnly": true, - "type": "string" - }, - "timeSeriesIdProperties": { - "description": "Time series ID properties defined during environment creation.", - "readOnly": true, - "$ref": "#/definitions/TimeSeriesIdProperties" - }, - "defaultTypeId": { - "description": "Default type ID of the model that new time series instances will automatically belong to.", - "readOnly": true, - "type": "string" - } - } - }, - "TimeSeriesIdProperties": { - "description": "Time series ID properties defined during environment creation.", - "type": "array", - "items": { - "$ref": "#/definitions/TimeSeriesIdProperty" - }, - "minItems": 1 - }, - "TimeSeriesIdProperty": { - "description": "A definition of a single property that can be used in time series ID properties defined during environment creation.", - "type": "object", - "properties": { - "name": { - "description": "The name of the property.", - "readOnly": true, - "type": "string" - }, - "type": { - "description": "The type of the property. Currently, only \"String\" is supported.", - "readOnly": true, - "type": "string", - "enum": [ - "String" - ], - "x-ms-enum": { - "name": "TimeSeriesIdPropertyTypes", - "modelAsString": true - } - } - } - }, - "UpdateModelSettingsRequest": { - "description": "Request to update model settings. One of \"name\" or \"defaultTypeId\" must be set.", - "type": "object", - "properties": { - "name": { - "description": "Model display name which is shown in the UX and mutable by the user. Initial value is \"DefaultModel\".", - "type": "string" - }, - "defaultTypeId": { - "description": "Default type id of the model that new instances will automatically belong to.", - "type": "string" - } - } - }, - "SearchInstancesRequest": { - "description": "Request to execute a search query against time series instances and return matching time series instances.", - "type": "object", - "properties": { - "searchString": { - "description": "Query search string that will be matched to the attributes of time series instances. Example: \"floor 100\". Case-insensitive, must be present, but can be empty string.", - "type": "string" - }, - "path": { - "description": "Filter on hierarchy path of time series instances. Path is represented as array of string path segments. First element should be hierarchy name. Example: [\"Location\", \"California\"]. Optional, case sensitive, never empty and can be null.", - "type": "array", - "items": { - "type": "string" - } - }, - "instances": { - "description": "Parameters of how to return time series instances. Can be null. When both the instances and hierarchies parameters are null, the instances are returned in the results based on the default values of parameters, and hierarchies are not returned.", - "type": "object", - "$ref": "#/definitions/SearchInstancesParameters" - }, - "hierarchies": { - "description": "Parameters of how to return time series instance hierarchies. If null, hierarchies are not returned. If instances parameter is null and hierarchies parameter is not null, only hierarchies with no instances are returned.", - "type": "object", - "$ref": "#/definitions/SearchInstancesHierarchiesParameters" - } - }, - "required": [ - "searchString" - ] - }, - "SearchInstancesParameters": { - "description": "Parameters of how to return time series instances by search instances call.", - "type": "object", - "properties": { - "recursive": { - "description": "Definition of which instances are returned. When recursive is set to 'true', all instances that have the path that starts with path the path parameter are returned. When recursive is set to 'false', only instances that have the path that exactly matches the path parameter are returned. Using recursive search allows to implement search user experience, while using non-recursive search allows to implement navigation experience. Optional, default is 'true'.", - "type": "boolean" - }, - "sort": { - "description": "Definition of how time series instances are sorted before being returned by search instances call - relevance or alphabetical. Optional, default is \"Rank\".", - "type": "object", - "$ref": "#/definitions/InstancesSortParameter" - }, - "highlights": { - "description": "Definition of highlighted search results or not. When it is set to 'true', the highlighted search results are returned. When it is set to 'false', the highlighted search results are not returned. Default is 'true'.", - "type": "boolean" - }, - "pageSize": { - "description": "Maximum number of instances expected in each page of the result. Defaults to 10 when not set. Ranges from 1 to 100. If there are results beyond the page size, the user can use the continuation token to fetch the next page.", - "type": "integer", - "format": "int32" - } - } - }, - "InstancesSortParameter": { - "description": "Definition of how time series instances are sorted before being returned by search instances call.", - "type": "object", - "properties": { - "by": { - "description": "Value to use for sorting of the time series instances before being returned by search instances call. When it is set to 'Rank', the returned instances are sorted based on the relevance. When it is set to 'DisplayName', the returned results are sorted based on the display name. Display name is the name of the instance if it exists, otherwise, display name is the time series ID. Default is 'Rank'.", - "type": "string", - "enum": [ - "Rank", - "DisplayName" - ], - "x-ms-enum": { - "name": "InstancesSortBy", - "modelAsString": true - } - } - } - }, - "SearchInstancesHierarchiesParameters": { - "description": "Parameter of how to return time series instance hierarchies by search instances call.", - "type": "object", - "properties": { - "expand": { - "description": "Definition of whether to expand hierarchy nodes in the same search instances call. Optional, default is 'UntilChildren'.", - "type": "object", - "$ref": "#/definitions/HierarchiesExpandParameter" - }, - "sort": { - "description": "Definition of sorting of hierarchy nodes. Optional, default is 'CumulativeInstanceCount'.", - "type": "object", - "$ref": "#/definitions/HierarchiesSortParameter" - }, - "pageSize": { - "description": "Maximum number of hierarchies in the same level to return in the same page. Optional, default is 10 when not set. Range is from 1 to 100. If there are results beyond the page size, the continuation token can be used to fetch the next page.", - "type": "integer", - "format": "int32" - } - } - }, - "HierarchiesExpandParameter": { - "description": "Definition of whether to expand hierarchy nodes in the same search instances call.", - "type": "object", - "properties": { - "kind": { - "description": "Kind of the expansion of hierarchy nodes. When it is set to 'UntilChildren', the hierarchy nodes are expanded recursively until there is more than one child. When it is set to 'OneLevel', the hierarchies are expanded only at the single level matching path search instances parameter. Optional, default is 'UntilChildren'.", - "type": "string", - "enum": [ - "UntilChildren", - "OneLevel" - ], - "x-ms-enum": { - "name": "HierarchiesExpandKind", - "modelAsString": true - } - } - } - }, - "HierarchiesSortParameter": { - "description": "Definition of sorting of hierarchy nodes.", - "type": "object", - "properties": { - "by": { - "description": "Value to use for hierarchy node sorting. When it is set to 'CumulativeInstanceCount', the returned hierarchies are sorted based on the total instances belonging to the hierarchy node and its child hierarchy nodes. When it is set to 'Name', the returned hierarchies are sorted based on the hierarchy name. Optional, default is 'CumulativeInstanceCount'.", - "type": "string", - "enum": [ - "CumulativeInstanceCount", - "Name" - ], - "x-ms-enum": { - "name": "HierarchiesSortBy", - "modelAsString": true - } - } - } - }, - "SearchInstancesResponsePage": { - "description": "Single page of the search results.", - "type": "object", - "properties": { - "instances": { - "description": "The instances matching the query based on the input. May be empty or null.", - "readOnly": true, - "type": "object", - "$ref": "#/definitions/SearchInstancesResponse" - }, - "hierarchyNodes": { - "description": "The hierarchy nodes which contains the instances matching the query based on the input. May be empty or null.", - "readOnly": true, - "type": "object", - "$ref": "#/definitions/SearchHierarchyNodesResponse" - } - } - }, - "SearchInstancesResponse": { - "description": "The instances matching the query based on the input. May be empty or null.", - "type": "object", - "properties": { - "hits": { - "description": "The list of instances matching the query based on the input. May be empty.", - "readOnly": true, - "type": "array", - "items": { - "$ref": "#/definitions/InstanceHit" - } - }, - "hitCount": { - "description": "Total number of instances matching the query based on the input.", - "readOnly": true, - "type": "integer", - "format": "int32" - }, - "continuationToken": { - "description": "If returned, this means that current results represent a partial result. Continuation token allows to get the next page of results. To get the next page of query results, send the same request with continuation token parameter in \"x-ms-continuation\" HTTP header.", - "readOnly": true, - "type": "string" - } - } - }, - "SearchHierarchyNodesResponse": { - "description": "The hierarchy nodes which contains the instances matching the query based on the input. May be empty or null.", - "type": "object", - "properties": { - "hits": { - "description": "The list of hierarchy nodes which contains the instances matching the query based on the input. May be empty.", - "type": "array", - "readOnly": true, - "items": { - "$ref": "#/definitions/HierarchyHit" - } - }, - "hitCount": { - "description": "Total number of hierarchy nodes which contains the instances matching the query based on the input.", - "readOnly": true, - "type": "integer", - "format": "int32" - }, - "continuationToken": { - "description": "If returned, this means that current results represent a partial result. Continuation token allows to get the next page of results. To get the next page of query results, send the same request with continuation token parameter in \"x-ms-continuation\" HTTP header.", - "readOnly": true, - "type": "string" - } - } - }, - "InstanceHit": { - "description": "Time series instance that is returned by instances search call. Returned instance matched the search request and contains highlighted text to be displayed to the user if it is set to 'true'.", - "type": "object", - "properties": { - "timeSeriesId": { - "description": "Time series ID of the time series instance that matched the search request.", - "readOnly": true, - "type": "array", - "$ref": "#/definitions/TimeSeriesId" - }, - "name": { - "description": "Name of the time series instance that matched the search request. May be null.", - "readOnly": true, - "type": "string" - }, - "typeId": { - "description": "Represents the type that time series instance which matched the search request belongs to. Never null.", - "readOnly": true, - "type": "string" - }, - "hierarchyIds": { - "description": "List of time series hierarchy IDs that time series instance which matched the search request belongs to. Cannot be used to lookup hierarchies. May be null.", - "readOnly": true, - "type": "array", - "items": { - "type": "string" - } - }, - "highlights": { - "description": "Highlighted text of time series instance to be displayed to the user. Highlighting inserts and tags in the portions of text that matched the search string. Do not use any of the highlighted properties to do further API calls.", - "readOnly": true, - "type": "object", - "properties": { - "timeSeriesId": { - "description": "List of highlighted string values of Time Series ID for displaying. Cannot be used to lookup instance.", - "readOnly": true, - "type": "array", - "items": { - "type": "string" - } - }, - "typeName": { - "description": "Highlighted time series type name that this instance belongs to.", - "readOnly": true, - "type": "string" - }, - "name": { - "description": "Highlighted name of time series instance. May be null.", - "readOnly": true, - "type": "string" - }, - "description": { - "description": "Highlighted description of time series instance. May be null.", - "readOnly": true, - "type": "string" - }, - "hierarchyIds": { - "description": "List of highlighted time series hierarchy IDs that time series instance belongs to. Cannot be used to lookup hierarchies. May be null.", - "readOnly": true, - "type": "array", - "items": { - "type": "string" - } - }, - "hierarchyNames": { - "description": "List of highlighted time series hierarchy names that time series instance belongs to. Cannot be used to lookup hierarchies. May be null.", - "readOnly": true, - "type": "array", - "items": { - "type": "string" - } - }, - "instanceFieldNames": { - "description": "List of highlighted time series instance field names. May be null.", - "readOnly": true, - "type": "array", - "items": { - "type": "string" - } - }, - "instanceFieldValues": { - "description": "List of highlighted time series instance field values. May be null.", - "readOnly": true, - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - }, - "HierarchyHit": { - "description": "The hierarchy node which contains the instances matching the query based on the input. May be empty or null.", - "type": "object", - "properties": { - "name": { - "description": "Name of the hierarchy node. May be empty, cannot be null.", - "readOnly": true, - "type": "string" - }, - "cumulativeInstanceCount": { - "description": "Total number of instances that belong to this node and it's subtrees matching the query.", - "readOnly": true, - "type": "integer", - "format": "int32" - }, - "hierarchyNodes": { - "description": "Child hierarchy nodes of this node. May be empty or null.", - "readOnly": true, - "type": "object", - "$ref": "#/definitions/SearchHierarchyNodesResponse" - } - } - }, - "InstancesSuggestRequest": { - "description": "Request to get search string suggestions for time series instances search based on prefix text.", - "type": "object", - "properties": { - "searchString": { - "description": "Search string for which suggestions are required. Empty is allowed, but not null.", - "type": "string" - }, - "take": { - "description": "Maximum number of suggestions expected in the result. Defaults to 10 when not set.", - "type": "integer", - "format": "int32" - } - }, - "required": [ - "searchString" - ] - }, - "InstancesSuggestResponse": { - "description": "Response of getting suggestions for search for time series instances.", - "type": "object", - "properties": { - "suggestions": { - "description": "List of instance suggestions for searching time series models.", - "readOnly": true, - "type": "array", - "items": { - "$ref": "#/definitions/InstancesSearchStringSuggestion" - } - } - } - }, - "InstancesSearchStringSuggestion": { - "description": "Suggested search string to be used for further search for time series instances.", - "type": "object", - "properties": { - "searchString": { - "description": "Suggested search string. Can be used for further search for time series instances.", - "readOnly": true, - "type": "string" - }, - "highlightedSearchString": { - "description": "Highlighted suggested search string to be displayed to the user. Highlighting inserts and tags in the portions of text that matched the search string. Do not use highlighted search string to do further search calls.", - "readOnly": true, - "type": "string" - } - } - }, - "PagedResponse": { - "description": "Partial result that has continuation token to fetch the next partial result.", - "type": "object", - "properties": { - "continuationToken": { - "description": "If returned, this means that current results represent a partial result. Continuation token allows to get the next page of results. To get the next page of query results, send the same request with continuation token parameter in \"x-ms-continuation\" HTTP header.", - "readOnly": true, - "type": "string" - } - } - }, - "EventProperty": { - "description": "Property of an event that is either stored or computed. Properties are identified by both name and type. Different events can have properties with same name, but different type.", - "type": "object", - "properties": { - "name": { - "description": "The name of the property.", - "type": "string" - }, - "type": { - "description": "The type of the property.", - "$ref": "#/definitions/PropertyType" - } - } - }, - "PropertyType": { - "description": "The type of the property that is either stored in events or computed by a calculation.", - "type": "string", - "enum": [ - "Bool", - "DateTime", - "Double", - "String", - "TimeSpan", - "Long" - ], - "x-ms-enum": { - "name": "PropertyTypes", - "modelAsString": true - } - }, - "TsiError": { - "description": "Information about an API error.", - "type": "object", - "properties": { - "error": { - "$ref": "#/definitions/TsiErrorBody" - } - }, - "x-ms-external": false - }, - "TsiErrorBody": { - "description": "A particular API error with an error code and a message.", - "type": "object", - "properties": { - "code": { - "description": "Language-independent, human-readable string that defines a service-specific error code. This code serves as a more specific indicator for the HTTP error code specified in the response. Can be used to programmatically handle specific error cases.", - "readOnly": true, - "type": "string" - }, - "message": { - "description": "Human-readable, language-independent representation of the error. It is intended as an aid to developers and is not suitable for exposure to end users.", - "readOnly": true, - "type": "string" - }, - "target": { - "description": "Target of the particular error (for example, the name of the property in error). May be null.", - "readOnly": true, - "type": "string" - }, - "innerError": { - "description": "Contains more specific error that narrows down the cause. May be null.", - "readOnly": true, - "$ref": "#/definitions/TsiErrorBody" - }, - "details": { - "description": "Contains additional error information. May be null.", - "readOnly": true, - "type": "array", - "items": { - "$ref": "#/definitions/TsiErrorDetails" - } - } - }, - "additionalProperties": true, - "x-ms-external": false - }, - "TsiErrorDetails": { - "description": "Additional error information.", - "type": "object", - "properties": { - "code": { - "description": "Language-independent, human-readable string that defines a service-specific error code. This code serves as a more specific indicator for the HTTP error code specified in the response. Can be used to programmatically handle specific error cases.", - "readOnly": true, - "type": "string" - }, - "message": { - "description": "Human-readable, language-independent representation of the error. It is intended as an aid to developers and is not suitable for exposure to end users.", - "readOnly": true, - "type": "string" - } - }, - "additionalProperties": true, - "x-ms-external": false - } - }, - "parameters": { - "ApiVersion": { - "name": "api-version", - "in": "query", - "required": true, - "default": "2018-11-01-preview", - "type": "string", - "description": "Version of the API to be used with the client request. Currently supported version is \"2018-11-01-preview\"." - }, - "StoreType": { - "name": "storeType", - "in": "query", - "required": false, - "type": "string", - "x-ms-parameter-location": "method", - "description": "For the environments with warm store enabled, the query can be executed either on the 'WarmStore' or 'ColdStore'. This parameter in the query defines which store the query should be executed on. If not defined, the query will be executed on the cold store." - }, - "EnvironmentFqdn": { - "name": "environmentFqdn", - "in": "path", - "required": true, - "type": "string", - "x-ms-skip-url-encoding": true, - "x-ms-parameter-location": "client", - "description": "Per environment FQDN, for example 10000000-0000-0000-0000-100000000109.env.timeseries.azure.com. You can obtain this domain name from the response of the Get Environments API, Azure portal, or Azure Resource Manager." - }, - "ContinuationToken": { - "name": "x-ms-continuation", - "x-ms-client-name": "continuationToken", - "in": "header", - "required": false, - "type": "string", - "x-ms-parameter-location": "method", - "description": "Continuation token from previous page of results to retrieve the next page of the results in calls that support pagination. To get the first page results, specify null continuation token as parameter value. Returned continuation token is null if all results have been returned, and there is no next page of results." - }, - "ClientRequestId": { - "name": "x-ms-client-request-id", - "x-ms-client-name": "clientRequestId", - "in": "header", - "required": false, - "type": "string", - "x-ms-parameter-location": "method", - "description": "Optional client request ID. Service records this value. Allows the service to trace operation across services, and allows the customer to contact support regarding a particular request." - }, - "ClientSessionId": { - "name": "x-ms-client-session-id", - "x-ms-client-name": "clientSessionId", - "in": "header", - "required": false, - "type": "string", - "x-ms-parameter-location": "method", - "description": "Optional client session ID. Service records this value. Allows the service to trace a group of related operations across services, and allows the customer to contact support regarding a particular group of requests." - } - } -} diff --git a/specification/web/resource-manager/readme.md b/specification/web/resource-manager/readme.md index 3ca278652c6d..9b43273bd834 100644 --- a/specification/web/resource-manager/readme.md +++ b/specification/web/resource-manager/readme.md @@ -59,7 +59,7 @@ directive: These settings apply only when `--tag=package-2021-01-15` is specified on the command line. -```yaml $(tag) == 'package-2021-01-15' +```yaml $(tag) == 'package-2021-01-15' || $(tag) == 'package-2021-01-15-only' input-file: - Microsoft.CertificateRegistration/stable/2021-01-15/AppServiceCertificateOrders.json - Microsoft.CertificateRegistration/stable/2021-01-15/CertificateOrdersDiagnostics.json diff --git a/specification/web/resource-manager/readme.python.md b/specification/web/resource-manager/readme.python.md index 63194c70f572..76a2702606eb 100644 --- a/specification/web/resource-manager/readme.python.md +++ b/specification/web/resource-manager/readme.python.md @@ -21,6 +21,7 @@ Generate all API versions currently shipped for this package ```yaml $(python) && $(multiapi) clear-output-folder: true batch: + - tag: package-2021-01-15-only - tag: package-2021-01-only - tag: package-2020-12-only - tag: package-2020-09-only @@ -42,6 +43,16 @@ clear-output-folder: false perform-load: false ``` +### Tag: package-2021-01-15-only and python + +These settings apply only when `--tag=package-2021-01-15-only --python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +``` yaml $(tag) == 'package-2021-01-15-only' && $(python) +namespace: azure.mgmt.web.v2021_01_15 +output-folder: $(python-sdks-folder)/appservice/azure-mgmt-web/azure/mgmt/web/v2021_01_15 +``` + ### Tag: package-2021-01-only and python These settings apply only when `--tag=package-2021-01-only --python` is specified on the command line.